Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductDomains and accessMember Directory

Member Directory routes: deactivate, deprovision, provision

The Member Directory Verbs deactivate, deprovision, provision as api.sb routes, with inputs, result, refusals and an example.

Reference for Member Directory, one group of Member Directory routes.

MemberDirectory.deactivate

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

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

Path: directory. Emits MemberDirectory.deactivated.

Inputs

InputTypeRequiredDescription
directoryMember DirectoryrequiredThe Member Directory to turn off.

Returns

OutputTypeRequiredDescription
directoryMember DirectoryrequiredThe Member Directory, now inactive.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN/deactivate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "directory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MemberDirectory.deactivate",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

MemberDirectory.deprovision

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

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

Path: directory. Body, as JSON: the other inputs. Emits MemberDirectory.deprovisioned.

Inputs

InputTypeRequiredDescription
directoryMember DirectoryrequiredThe Member Directory that removed the person.
personPersonrequiredThe person removed.

Returns

OutputTypeRequiredDescription
personPersonrequiredThe person, with no Role left in the Tenant.
memberDirectoryMember DirectoryrequiredThe Member Directory that removed the person.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN/deprovision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person":"person_sLqbXbW683"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "person": {
    "$id": "https://api.sb/leaseline.app/people/person_sLqbXbW683",
    "$type": "Person",
    "name": "Dana Okafor"
  },
  "memberDirectory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MemberDirectory.deprovision",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

MemberDirectory.provision

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

Text
POST /{namespace}/member-directories/provision

Body, as JSON: the inputs. Emits MemberDirectory.provisioned.

Inputs

InputTypeRequiredDescription
tenantTenantrequiredThe Tenant it fills.
groupRolesjsonWhich group fills which Role.

Returns

OutputTypeRequiredDescription
directoryMember DirectoryrequiredThe Member Directory, now active.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/member-directories/provision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenant":"ten_Bu63f0he26"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "directory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MemberDirectory.provision",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update

Previous

SSO Connection

Next