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
The providers resource returns a list of the cloud providers configured with the deployment, including the provider name, connection information, and provider ID.
Request parameters
| Parameter | Details |
|---|---|
| Determines how the encrypted secret key is returned. When Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the providers resource:
https://organization.example.com/<context>/admin/cloud/providers?maskedSecret=true&f=pjsonJSON Response example
The following sample JSON response is returned when either masked is set as false, or masked is not included in the request:
{
"cloudProviders": [
{
"cloudServices": [
{
"providerId": "xxmrejycd2",
"usage": "DEFAULT",
"name": "AWS S3",
"connection": {
"bucketName": "cloud-native-store",
"rootDir": "arcgis",
"region": "us-east-2"
},
"id": "jy568v1fhn",
"type": "objectStore",
"category": "storage"
}
],
"credential": {
"secret": {
"secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
"accessKey": "{crypt}+1FSvRmPvGDJXo1FY5ug9vcxrlAuZ+QN"
},
"type": "ACCESS-KEY"
},
"name": "AWS",
"id": "xxmrejycd2"
}
]
}The sample JSON below is returned when masked is set as true:
{
"cloudProviders": [
{
"cloudServices": [
{
"providerId": "s7my5d949q",
"usage": "DEFAULT",
"name": "AWS S3",
"connection": {
"bucketName": "cloud-native-store",
"rootDir": "arcgisecs",
"region": "us-east-2"
},
"id": "wpjkp9s7ub",
"type": "objectStore",
"category": "storage"
}
],
"credential": {
"secret": {
"secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
"accessKey": "xxxxxxxxxxxxxxxxAZXL"
},
"type": "ACCESS-KEY"
},
"name": "AWS",
"id": "s7my5d949q"
}
]
}