Skip to content

by Startups.Studio

Product Domains and access Member Directory

MemberDirectory.deactivate

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

Deactivate stops a Member Directory’s pushes; everyone it added keeps their Roles until an admin removes them.

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

You, to your agent

Deactivate the latest member directory.

curl -X POST https://api.sb/ledgerlark.com/member-directories/member_directory_1/deactivate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const directory = await $.MemberDirectory.deactivate({ directory: 'member_directory_1' })

npx startup-builder do MemberDirectory.deactivate --json '{"directory":"member_directory_1"}'

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

Deactivate stops a Member Directory’s pushes; the people it added keep their Roles until an admin removes them.

Inputs

Input	Type	Required	Description
`directory`	Member Directory	required	The Member Directory to turn off.

Outputs

Output	Type	Required	Description
`directory`	Member Directory	required	The Member Directory, now `inactive`.

Effects

Emits MemberDirectory.deactivated.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.

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.deactivate

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.create

Previous Page

MemberDirectory.deprovision

Next Page