identities.update_scopes
Add or remove scopes from an identity
Key type: Platform (lopk-)
Add or remove permission scopes from an identity. At least one of addScopes or removeScopes must be provided.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identityId | string | Yes | Identity ID |
addScopes | string[] | No | Scopes to add |
removeScopes | string[] | No | Scopes to remove |
Available scopes: mail:read, mail:send, mail:manage, vault:read, vault:write, identity:sign, identity:verify, calendar:read, calendar:write, calendar:delete, calendar:public
Example
Orchestrator: "Give the sales agent vault access"
-> identities.update_scopes({
identityId: "id-abc123",
addScopes: ["vault:read", "vault:write"]
})Returns
{
"identityId": "id-abc123",
"scopes": ["mail:read", "mail:send", "vault:read", "vault:write"]
}REST Equivalent
PATCH /v0/platform/identities/:identityId