Update Credential - Cloud Service | ArcGIS REST APIs

URL:: https://<root>/cloud/services/<serviceID>/credential/update
Methods:: POST
Version Introduced:: 12.0

Access requirements

Required privileges

The Sever 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.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS Server 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 ArcGIS Server Administrator API generateToken operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.

Learn how to generate a token

Description

The credential/update operation supports the following workflows:

Updating existing credential information for a cloud service
Switching the credential type
Moving from key-based models to identity or role-based models

The request must include the credential information for the service, which is returned by the Services resource. Once submitted, the request returns a job ID that you can use to query the Job resource. The HTML response also returns a link that can be used to access the job page for the request.

Request parameters

Parameter Details

Parameter	Details
`credential`	The updated credential object. The current credential object can be retrieved and modified from the Services resource. Amazon S3 Access Key ExampleAmazon S3 Access Key ExampleAmazon S3 IAM Role ExampleAzure Blob Storage User-Assigned Managed Identity ExampleAzure Blob Storage Service Principal ExampleAzure Blob Storage Account Key ExampleAzure Blob Storage Azure Cosmos DB Account Key ExampleAzure Blob Storage Azure Service Bus Access Key Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 { "type": "ACCESS-KEY", "secret": { "secret_key": "<secret_key>", "access_key": "<access_key>" } }`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

credential

The updated credential object. The current credential object can be retrieved and modified from the Services resource.

Amazon S3 Access Key Example

Amazon S3 IAM Role Example

Azure Blob Storage User-Assigned Managed Identity Example

Azure Blob Storage Service Principal Example

Azure Blob Storage Account Key Example

Azure Blob Storage Azure Cosmos DB Account Key Example

Azure Blob Storage Azure Service Bus Access Key Example

Use dark colors for code blocksCopy
{
  "type": "ACCESS-KEY",
  "secret": {
    "secret_key": "<secret_key>",
    "access_key": "<access_key>"
  }
}

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the credential/update operation:

Use dark colors for code blocksCopy
POST /<context>/admin/clouds/services/eg7hrelq6b/credential/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

credential={"type":"STORAGE-ACCOUNT-KEY","secret": {"storageAccountName": "v2Crypt_R68p/cvTUo1LmRcgXJ5U07WKv936mnCe","storageAccountKey": "v2Crypt_xxxxxxxxxxxxxxxxVC5M"}}&f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response example

Use dark colors for code blocksCopy
{
  "cloudCredentialRotationJobId": j876ae6e7-27d9-4b2d-b8ab-d07e2433e2c1",
  "message": "A cloud credentials rotation job is in-progress"
}