Service Account reference

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 16 methods. Search the docs for an exact method name, or use this index:

serviceAccount.get()
serviceAccount.list()
serviceAccount.create()
serviceAccount.update()
serviceAccount.delete()
serviceAccount.activate()
serviceAccount.disable()
serviceAccount.restore()
serviceAccount.enablePlatformAccess()
serviceAccount.disablePlatformAccess()
serviceAccount.getKeys()
serviceAccount.getKey()
serviceAccount.createKey()
serviceAccount.updateKey()
serviceAccount.rotateKey()
serviceAccount.revokeKey()

`serviceAccount.get()`

Reads a service account admitted by IAM and its management ACL. Example: const account = await serviceAccount.get({ name: ‘erp-sync’ });

Signature

static get(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.list()`

Lists visible service accounts; authorization is applied before pagination. Example: const accounts = await serviceAccount.list({ take: 20, count: true });

Signature

static list(query?: ServiceAccountQuery): Promise<CollectionResult<ServiceAccountRecord>>;

`serviceAccount.create()`

Atomic account + ACL + memberships creation; default ACL contains creator and self.

Signature

static create(input: ServiceAccountCreateInput): Promise<ServiceAccountRecord>;

Example

const account = await serviceAccount.create({ name: 'erp-sync', memberships: { roleGroups: ['Integration runtime'] } });

`serviceAccount.update()`

Omitted fields preserve values; [] clears memberships/ACL entries. Requires version.

Signature

static update(ref: ServiceAccountRef, input: ServiceAccountUpdateInput): Promise<ServiceAccountRecord>;

Example

const account = await serviceAccount.get('erp-sync');
await serviceAccount.update('erp-sync', { version: account.version, memberships: { roleGroups: [] } });

`serviceAccount.delete()`

Deletes the account and its credentials through the existing account lifecycle. Example: await serviceAccount.delete(‘erp-sync’);

Signature

static delete(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.activate()`

Activates the account within the caller’s current delegation ceiling. Example: await serviceAccount.activate(‘erp-sync’);

Signature

static activate(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.disable()`

Disables the account while preserving its API key records. Example: await serviceAccount.disable(‘erp-sync’);

Signature

static disable(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.restore()`

Restores a deleted account as inactive; deleted credentials are not restored. Example: await serviceAccount.restore(‘erp-sync’);

Signature

static restore(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.enablePlatformAccess()`

Enables platform access within the current delegation ceiling. Example: await serviceAccount.enablePlatformAccess(‘erp-sync’);

Signature

static enablePlatformAccess(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.disablePlatformAccess()`

Disables platform access using the same IAM, ACL and target-rank policy. Example: await serviceAccount.disablePlatformAccess(‘erp-sync’);

Signature

static disablePlatformAccess(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;

`serviceAccount.getKeys()`

Lists safe key metadata without usable credentials. Example: const keys = await serviceAccount.getKeys(‘erp-sync’, { take: 20 });

Signature

static getKeys(ref: ServiceAccountRef, query?: ServiceAccountQuery): Promise<CollectionResult<ServiceAccountKey>>;

`serviceAccount.getKey()`

Reads a key by its UUID; the credential value is never returned. Example: const key = await serviceAccount.getKey(‘erp-sync’, input.userKeyId);

Signature

static getKey(ref: ServiceAccountRef, userKeyId: string): Promise<ServiceAccountKey>;

`serviceAccount.createKey()`

Return secret once; store it immediately and never log it.

Signature

static createKey(ref: ServiceAccountRef, input: ServiceAccountKeyCreateInput): Promise<ServiceAccountKeyCreated>;

Example

const key = await serviceAccount.createKey('erp-sync', { name: 'primary', restricted: false });
await vault.create('ERP_API_KEY', { value: key.secret });

`serviceAccount.updateKey()`

expireAt is immutable here; use rotateKey to change the successor expiry.

Signature

static updateKey(ref: ServiceAccountRef, userKeyId: string, input: ServiceAccountKeyUpdateInput): Promise<ServiceAccountKey>;

Example

const key = await serviceAccount.getKey('erp-sync', input.userKeyId);
await serviceAccount.updateKey('erp-sync', key.userKeyId, { version: key.version, name: 'primary' });

`serviceAccount.rotateKey()`

Creates a new credential; gracePeriodMs defaults to 0, max 365 days. Omit expireAt to inherit it, pass null for no expiration, or a date at least four hours ahead.

Signature

static rotateKey(ref: ServiceAccountRef, userKeyId: string, input: ServiceAccountKeyRotateInput): Promise<ServiceAccountKeyRotated>;

Example

const key = await serviceAccount.getKey('erp-sync', input.userKeyId);
const { newKey } = await serviceAccount.rotateKey('erp-sync', key.userKeyId, { version: key.version, gracePeriodMs: 60000 });
await vault.rotate('ERP_API_KEY', { value: newKey.secret });

`serviceAccount.revokeKey()`

Revokes a key without requiring a delegation ceiling; role, ACL and target rank still apply. Example: await serviceAccount.revokeKey(‘erp-sync’, input.userKeyId);

Signature

static revokeKey(ref: ServiceAccountRef, userKeyId: string): Promise<ServiceAccountKey>;

​serviceAccount.get()

​Signature

​serviceAccount.list()

​Signature

​serviceAccount.create()

​Signature

​Example

​serviceAccount.update()

​Signature

​Example

​serviceAccount.delete()

​Signature

​serviceAccount.activate()

​Signature

​serviceAccount.disable()

​Signature

​serviceAccount.restore()

​Signature

​serviceAccount.enablePlatformAccess()

​Signature

​serviceAccount.disablePlatformAccess()

​Signature

​serviceAccount.getKeys()

​Signature

​serviceAccount.getKey()

​Signature

​serviceAccount.createKey()

​Signature

​Example

​serviceAccount.updateKey()

​Signature

​Example

​serviceAccount.rotateKey()

​Signature

​Example

​serviceAccount.revokeKey()

​Signature

`serviceAccount.get()`

Signature

`serviceAccount.list()`

Signature

`serviceAccount.create()`

Signature

Example

`serviceAccount.update()`

Signature

Example

`serviceAccount.delete()`

Signature

`serviceAccount.activate()`

Signature

`serviceAccount.disable()`

Signature

`serviceAccount.restore()`

Signature

`serviceAccount.enablePlatformAccess()`

Signature

`serviceAccount.disablePlatformAccess()`

Signature

`serviceAccount.getKeys()`

Signature

`serviceAccount.getKey()`

Signature

`serviceAccount.createKey()`

Signature

Example

`serviceAccount.updateKey()`

Signature

Example

`serviceAccount.rotateKey()`

Signature

Example

`serviceAccount.revokeKey()`

Signature