Service Accounts

Update

client.organizations.serviceAccounts.update(, , ?): ServiceAccount { id, created_at, name, 3 more }

PATCH/organizations/{organization_id}/service-accounts/{service_account_id}

Update a service account

ParametersExpand Collapse

serviceAccountID: string

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

params: ServiceAccountUpdateParams { organization_id, description, name, xClientRequestID }

organization_id: string

Path param: Organization ID or label identifier

minLength1

maxLength255

description?: string

Body param: Optional description of the service account

maxLength500

name?: string

Body param: Service account name

xClientRequestID?: string

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

ReturnsExpand Collapse

ServiceAccount { id, created_at, name, 3 more }

id: string

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

created_at: string

The time the entity was created in utc

formatdate-time

name: string

A name for the entity to be displayed in UI

updated_at: string

The time the entity was mostly recently updated in utc

formatdate-time

description?: string

Optional description of the service account

permissions?: Record<string, Record<string, boolean>>

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.

Update

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

const serviceAccount = await client.organizations.serviceAccounts.update(
  'ab3def8hij2klm9opq5rst7uvw',
  { organization_id: 'x' },
);

console.log(serviceAccount.id);

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}

Returns Examples

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}