Member Directory methods: deactivate, deprovision, provision
The Member Directory Verbs deactivate, deprovision, provision as typed SDK methods, with inputs, result, refusals and an example.
Reference for Member Directory, one group of Member Directory methods.
MemberDirectory.deactivate
Deactivate stops a Member Directory’s pushes; everyone it added keeps their Roles until an admin removes them. Verb page.
interface MemberDirectoryVerbs {
deactivate(input: MemberDirectoryDeactivateInput, options?: SB.CallOptions): SB.Call<MemberDirectory>
}Emits MemberDirectory.deactivated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
directory | Member Directory | required | The Member Directory to turn off. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
directory | Member Directory | required | The Member Directory, now inactive. |
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 directory = await $.MemberDirectory.deactivate({ directory: 'directory_qZldlwGLVN' })MemberDirectory.deprovision
Deprovision ends one person’s access to a Tenant in one Action when the Customer’s directory removes them. Verb page.
interface MemberDirectoryVerbs {
deprovision(input: MemberDirectoryDeprovisionInput, options?: SB.CallOptions): SB.Call<MemberDirectoryDeprovisionOutput>
}Emits MemberDirectory.deprovisioned.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
directory | Member Directory | required | The Member Directory that removed the person. |
person | Person | required | The person removed. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
person | Person | required | The person, with no Role left in the Tenant. |
memberDirectory | Member Directory | required | The Member Directory that removed the person. |
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 { person, memberDirectory } = await $.MemberDirectory.deprovision({ directory: 'directory_qZldlwGLVN', person: 'person_sLqbXbW683' })MemberDirectory.provision
Provision starts a Customer’s Member Directory pushing people and groups into its Tenant, with groups mapped to Roles. Verb page.
interface MemberDirectoryVerbs {
provision(input: MemberDirectoryProvisionInput, options?: SB.CallOptions): SB.Call<MemberDirectory>
}Emits MemberDirectory.provisioned.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
tenant | Tenant | required | The Tenant it fills. |
groupRoles | json | Which group fills which Role. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
directory | Member Directory | required | The Member Directory, now active. |
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 directory = await $.MemberDirectory.provision({ tenant: 'ten_Bu63f0he26' })