Update Service Account
Last updated
Last updated
PUT /auth/service-accounts/{serviceAccountId}
Update a specific service account
User action signature required. See for more information.
Request headers required. See for more information.
Authentication required. See for more information.
Auth:Apps:Update
Always Required
Auth:Types:ServiceAccount
Always Required
serviceAccountId
*
the ID of the service account to update
/auth/service-accounts/us-em7bu-m6c48-hdqoobj7dj25pko
name
String
Optional
new name of the application, must be unique within the caller's org
externalId
String
Optional
new user defined value, that can be used to correlate the entity with an external system
{
"name": "My new Service Account name",
"externalId": "my_internal_id",
}
Success - The service account that was updated
{
"userInfo": {
"username": "My New Name",
"userId": "us-2q55i-g68v6-9etoie66crbdsh7k",
"kind": "CustomerEmployee",
"credentialUuid": "cr-4uc9u-12ij1-9s08327e73jqqcnr",
"orgId": "or-yanke-mars-6ulofamogg84s87v",
"permissions": [],
"scopes": [],
"isActive": true,
"isServiceAccount": true,
"isRegistered": true,
"permissionAssignments": [
{
"permissionId": "pm-paris-lithi-17bf4kf01h8ajph4",
"permissionName": "DfnsFullAdminAccess",
"assignmentId": "",
"operations": [
"ApiKeys:Create",
"ApiKeys:Read",
"ApiKeys:Revoke",
"AssetAccounts:Archive",
"AssetAccounts:Create",
"AssetAccounts:Read",
"Auth:Action:Sign",
"Auth:Apps:Create",
"Auth:Apps:Read",
"Auth:Apps:Update",
"Auth:Creds:Create",
"Auth:Creds:Read",
"Auth:Creds:Update",
"Auth:Types:Application",
"Auth:Types:Employee",
"Auth:Types:EndUser",
"Auth:Types:Pat",
"Auth:Types:ServiceAccount",
"Auth:Users:Create",
"Auth:Users:Delegate",
"Auth:Users:Read",
"Auth:Users:Update",
"Balances:Read",
"CallbackEvents:Read",
"CallbackSubscriptions:Archive",
"CallbackSubscriptions:Create",
"CallbackSubscriptions:Read",
"Employees:Read",
"Payments:Create",
"Payments:Read",
"PermissionAssignments:Create",
"PermissionAssignments:Read",
"PermissionAssignments:Revoke",
"PermissionPredicates:Archive",
"PermissionPredicates:Create",
"PermissionPredicates:Read",
"PermissionPredicates:Update",
"Permissions:Archive",
"Permissions:Create",
"Permissions:Read",
"Permissions:Update",
"Policies:Archive",
"Policies:Create",
"Policies:Read",
"Policies:Update",
"PolicyControlExecutions:Read",
"PolicyControlExecutions:Update",
"PolicyControls:Archive",
"PolicyControls:Create",
"PolicyControls:Read",
"PolicyControls:Update",
"PolicyRules:Archive",
"PolicyRules:Create",
"PolicyRules:Read",
"PolicyRules:Update",
"PublicKeyAddresses:Read",
"PublicKeys:Create",
"PublicKeys:Read",
"Signatures:Create",
"Signatures:Read",
"Transactions:Create",
"Transactions:Read",
"Wallets:Create",
"Wallets:Read",
"Wallets:Update"
]
}
]
},
"accessTokens": [
{
"dateCreated": "2023-04-12T23:49:33.767Z",
"credId": "",
"isActive": true,
"kind": "CustomerEmployee",
"linkedUserId": "us-2q55i-g68v6-9etoie66crbdsh7k",
"linkedAppId": "",
"name": "My new service account",
"orgId": "or-yanke-mars-6ulofamogg84s87v",
"permissionAssignments": [
{
"permissionId": "pm-paris-lithi-17bf4kf01h8ajph4",
"permissionName": "DfnsFullAdminAccess",
"assignmentId": "",
"operations": [
"ApiKeys:Create",
"ApiKeys:Read",
"ApiKeys:Revoke",
"AssetAccounts:Archive",
"AssetAccounts:Create",
"AssetAccounts:Read",
"Auth:Action:Sign",
"Auth:Apps:Create",
"Auth:Apps:Read",
"Auth:Apps:Update",
"Auth:Creds:Create",
"Auth:Creds:Read",
"Auth:Creds:Update",
"Auth:Types:Application",
"Auth:Types:Employee",
"Auth:Types:EndUser",
"Auth:Types:Pat",
"Auth:Types:ServiceAccount",
"Auth:Users:Create",
"Auth:Users:Delegate",
"Auth:Users:Read",
"Auth:Users:Update",
"Balances:Read",
"CallbackEvents:Read",
"CallbackSubscriptions:Archive",
"CallbackSubscriptions:Create",
"CallbackSubscriptions:Read",
"Employees:Read",
"Payments:Create",
"Payments:Read",
"PermissionAssignments:Create",
"PermissionAssignments:Read",
"PermissionAssignments:Revoke",
"PermissionPredicates:Archive",
"PermissionPredicates:Create",
"PermissionPredicates:Read",
"PermissionPredicates:Update",
"Permissions:Archive",
"Permissions:Create",
"Permissions:Read",
"Permissions:Update",
"Policies:Archive",
"Policies:Create",
"Policies:Read",
"Policies:Update",
"PolicyControlExecutions:Read",
"PolicyControlExecutions:Update",
"PolicyControls:Archive",
"PolicyControls:Create",
"PolicyControls:Read",
"PolicyControls:Update",
"PolicyRules:Archive",
"PolicyRules:Create",
"PolicyRules:Read",
"PolicyRules:Update",
"PublicKeyAddresses:Read",
"PublicKeys:Create",
"PublicKeys:Read",
"Signatures:Create",
"Signatures:Read",
"Transactions:Create",
"Transactions:Read",
"Wallets:Create",
"Wallets:Read",
"Wallets:Update"
]
}
],
"publicKey": "",
"tokenId": "to-79hoo-ohdi6-9rnomnmhiavfb335"
}
]
}
See for common errors.
See for service account management specific errors.