Skip to content

by Startups.Studio

Product Domains and access Member Directory

MemberDirectory.create

POST /{namespace}/member-directories

Creates a Member Directory.

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

You, to your agent

Add a member directory to PatentPad.

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

import { $ } from 'startup-builder'

const memberDirectory = await $.MemberDirectory.create({ groupRoles: {} })

npx startup-builder do MemberDirectory.create --json '{"groupRoles":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.MemberDirectory.create({ groupRoles: {} })"
  }
}

Create makes a new Member Directory from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`groupRoles`	`json`		Which directory group fills which Role in the Tenant.
`lastChangeAt`	`datetime`		When the Customer’s directory last pushed a change.
`tenant`	Tenant		A Member Directory fills and empties Roles in one Tenant as people join and leave the Customer.

Outputs

Output	Type	Required	Description
`memberDirectory`	Member Directory	required	The Member Directory.

Effects

Emits MemberDirectory.created.
Two-way: try, send, do.

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

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

Member Directory

Previous Page

MemberDirectory.deactivate

Next Page