Update Service Account

Edit online

Updates the configuration of a specific service account.

HTTP request
PUT /auth/service-accounts/{serviceAccountId}
Authentication
Authentication Type Supported
Organization User (CustomerEmployee) Yes
Delegated User (EndUser) No
Service Account Yes
Required permissions
Auth:ServiceAccounts:Update (always required)
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
X-DFNS-USERACTION string Yes User action signature used to sign change-inducing requests. See User Action Signing flows for details on generating this signature.
Path parameters
Parameter Type Required Description
serviceAccountId string Yes Unique identifier of the service account to update. Minimum length is 1.
Request body
Field Type Required Description
name string No Updated display name of the service account.
externalId string No Updated external identifier used for integration or tracking. 
curl --request PUT \
  --url https://api.digitalassets.ibm.com/auth/service-accounts/{serviceAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "name": "<string>",
  "externalId": "<string>"
}
'
Response
200: Success

Example response:

{
  "userInfo": {
    "username": "<string>",
    "name": "<string>",
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "kind": "AccountUser",
    "credentialUuid": "<string>",
    "orgId": "<string>",
    "isActive": true,
    "isServiceAccount": true,
    "isRegistered": true,
    "permissionAssignments": [
      {
        "permissionName": "<string>",
        "permissionId": "<string>",
        "assignmentId": "<string>",
        "operations": [
          "<string>"
        ]
      }
    ],
    "permissions": [
      "<string>"
    ]
  },
  "accessTokens": [
    {
      "dateCreated": "<string>",
      "credId": "<string>",
      "isActive": true,
      "kind": "Pat",
      "linkedUserId": "<string>",
      "linkedAppId": "<string>",
      "name": "<string>",
      "orgId": "<string>",
      "permissionAssignments": [
        {
          "permissionName": "<string>",
          "permissionId": "<string>",
          "assignmentId": "<string>",
          "operations": [
            "<string>"
          ]
        }
      ],
      "publicKey": "<string>",
      "tokenId": "<string>",
      "accessToken": "<string>"
    }
  ]
}