PUT/organizations/{organizationId}/roster/{userId}
Bind an encrypted roster profile document
Operation organizations.roster.update
Description
Binds a member's encrypted roster profile document to their organization roster entry. Members may bind their own profile; binding another member's requires organization administrator access.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
organizationId | path | string | required
|
userId | path | string | required
|
Request body
application/jsonUpdateOrganizationRosterEntryRequest
Binds or clears a roster entry's encrypted profile document.
1 field
profileDocumentIdstringrequirednullable- lowercase UUID v4
Other fields are allowed.
Responses
200 OK
application/jsonOrganizationDirectoryUserResponse
One organization roster entry with the user's registered keys. Display names live in the encrypted profile document.
15 fields
createdAtstringrequireddisabledAtstringrequirednullabledisabledByUserIdstringrequirednullableAdministrator who disabled the entry, or null.
encapsulationKeyFingerprintstringrequiredencapsulationPublicKeystringrequiredisPersonalOrganizationOwnerbooleanrequiredTrue for the user whose personal organization this is; they cannot be removed from it.
isSelfbooleanrequiredTrue for the caller's own entry.
joinedAtstringrequiredThe member's pending signed request to leave, shown only to administrators and the member.
profileDocumentIdstringrequirednullableEncrypted roster profile document, or null.
signingKeyFingerprintstringrequiredsigningPublicKeystringrequiredstatusstringrequired- one of
active,disabled
activemembers have access;disabledentries stay visible without access.- one of
updatedAtstringrequireduserIdstringrequired
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 402 | Payment Required |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|