Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
serviceAccountManagement

Update a service account.

Update an existing service account in the organization.

put/v1/serviceAccounts/{id}

Path parameters

idstring required

Identifier of the service account to update.

Request body

namestring

Name of the service account.

isActiveboolean

This has the value true if the service account is active and false if it has been deactivated.

roleIdsstring[]

List of role identifiers associated with the service account.

emailstring email

New email address of the service account.

Example request

{
  "name": "Service Account",
  "isActive": true,
  "roleIds": [
    "00000000000001DF",
    "00000000000002D2"
  ],
  "email": "johndoe@acme.com"
}

Response

The service account was successfully updated.

namestring required

Name of the service account.

emailstring email required

Email address of the service account.

roleIdsstring[] required

List of roleIds associated with the service account.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Unique identifier for the service account.

isActiveboolean

True if the service account is active.

Example response

{
  "name": "Service Account",
  "email": "johndoe@acme.com",
  "roleIds": [
    "00000000000001DF",
    "00000000000002D2"
  ],
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "000000000FE20FE2",
  "isActive": true
}