Skip to content

by Startups.Studio

Product Domains and access Member Directory

MemberDirectory.deprovision

POST /{namespace}/member-directories/{directory}/deprovision

Deprovision ends one person’s access to a Tenant in one Action when the Customer’s directory removes them.

Noun: Member Directory
Mode: do
Event: MemberDirectory.deprovisioned

You, to your agent

Deprovision the latest member directory with a person.

curl -X POST https://api.sb/shiftnote.app/member-directories/member_directory_1/deprovision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person":"person_1"}'

import { $ } from 'startup-builder'

const { person, memberDirectory } = await $.MemberDirectory.deprovision({ directory: 'member_directory_1', person: 'person_1' })

npx startup-builder do MemberDirectory.deprovision --json '{"directory":"member_directory_1","person":"person_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.MemberDirectory.deprovision({ directory: 'member_directory_1', person: 'person_1' })"
  }
}

Inputs

Input	Type	Required	Description
`directory`	Member Directory	required	The Member Directory that removed the person.
`person`	Person	required	The person removed.

Outputs

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.

Effects

Emits MemberDirectory.deprovisioned.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
Revokes the person’s keys, sign-ins and Mandates in the Tenant before their next call.
Keeps every record the person made, owned by the Tenant.

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.	MemberDirectory.deprovision

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

MemberDirectory.deactivate

Previous Page

MemberDirectory.get

Next Page