- URL:
- https://<root>/orgs/<orgID>
- Methods:
GET- Child Resources:
- Security, License, Federation, Properties
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
This resource provides access to a single organization within your deployment, allowing you to manage and update its licensing and security information, as well as manage its federated servers.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the organization resource:
https://organization.example.com/<context>/admin/orgs/0123456789ABCDEF?f=pjsonJSON Response example
The following is a sample JSON response for an organization resource. The response returns a web adaptor registration token that is specific to the organization, created when the organization was configured. The token is a base64 encoded JSON string that includes the organization's ID, the shared key that establishes trust between the web adaptor and your ArcGIS Enterprise on Kubernetes deployment, a list of nodes in the deployment, and the Ingress port. You will need to pass the token as part of the request when registering a web adaptor with your organization.
{
"webAdaptorRegistrationToken": "eyJvcmdJZCI6IjAxMjM0NTY3ODlBQkNERUYiLCJwcmVmaXhVcmwiOiJodHRwczovL2RldjAwMTQwOTIuZXNyaS5jb20vZ2lzLyIsImluZ3Jlc3NQb3J0IjoiMzE0NDMiLCJub2RlcyI6WyJkZXYwMDE0MDkyLmVzcmkuY29tIl0sInNoYXJlZEtleSI6IkVxTDk3ZytpS28xQUpMSVd2WDBWci94a1BEcGhVTno2Wjc4MlAxZXByTFE9IiwiZXhwaXJhdGlvbiI6MTU5NzI2NTQzMzg2OCwic2lnbmF0dXJlIjoiOXN2VE5pTjZFRDJkQkl4OUsrdWFBbVFSNGlaRGJ4VWpXa2NTRWFGaFM5aTBXSkVhZUVETE5RRU5sOW1EZnBXMiJ9",
"portalId": "db9bfd56-dcf6-4f0b-a5a2-af16a7972566"
}