Skip to content

by Startups.Studio

Product Domains and access Member Directory

MemberDirectory.provision

POST /{namespace}/member-directories/provision

Provision starts a Customer’s Member Directory pushing people and groups into its Tenant, with groups mapped to Roles.

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

You, to your agent

Provision the latest member directory with a tenant.

curl -X POST https://api.sb/tutorloop.com/member-directories/provision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenant":"tenant_1"}'

import { $ } from 'startup-builder'

const directory = await $.MemberDirectory.provision({ tenant: 'tenant_1' })

npx startup-builder do MemberDirectory.provision --json '{"tenant":"tenant_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.MemberDirectory.provision({ tenant: 'tenant_1' })"
  }
}

Inputs

Input	Type	Required	Description
`tenant`	Tenant	required	The Tenant it fills.
`groupRoles`	`json`		Which group fills which Role.

Outputs

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

Effects

Emits MemberDirectory.provisioned.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
Fills Roles for every person in a mapped group.

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

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

Previous Page

MemberDirectory.update

Next Page