Member Directory routes: update
The Member Directory Verbs update as api.sb routes, with inputs, result, refusals and an example.
Reference for Member Directory, one group of Member Directory routes.
MemberDirectory.update
Changes the given properties of a Member Directory. Verb page.
PATCH /{namespace}/ member-directories/ {id}Path: id. Body, as JSON: the other inputs. Emits MemberDirectory.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Member Directory. |
groupRoles | json | Which directory group fills which Role in the Tenant. | |
lastChangeAt | datetime | When the Customer’s directory last pushed a change. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
memberDirectory | Member Directory | required | The Member Directory. |
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. | None. |
Example
curl -X PATCH https: //api.sb/ leaseline.app/ member-directories/ directory_qZldlwGLVN \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"groupRoles": {}}'{
"api": "https: //api.sb/ leaseline.app",
"memberDirectory": {
"$id": "https: //api.sb/ leaseline.app/ member-directories/ directory_qZldlwGLVN",
"$type": "MemberDirectory",
"state": "draft",
"groupRoles": {}
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "MemberDirectory.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}