Member Directory methods: update
The Member Directory Verbs update as typed SDK methods, with inputs, result, refusals and an example.
Reference for Member Directory, one group of Member Directory methods.
MemberDirectory.update
Changes the given properties of a Member Directory. Verb page.
interface MemberDirectoryVerbs {
update(input: MemberDirectoryUpdateInput, options?: SB.CallOptions): SB.Call<MemberDirectory>
}Emits MemberDirectory.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Member Directory. |
groupRoles | json | Which directory group fills which Role in the Tenant. | |
lastChangeAt | datetime | When the Customer’s directory last pushed a change. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
memberDirectory | Member Directory | required | The Member Directory. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const memberDirectory = await $.MemberDirectory.update({ id: 'directory_qZldlwGLVN', groupRoles: {} })