Skip to navigation
API referenceOrganizationsIdentity and memberships

Read an active membership

Required scopes: membership.get.

Returns 404 for absent or foreign memberships. ETag is required for subsequent PATCH or DELETE.

Response headers:

  • ETag (200): Strong validator for this membership representation and row revision. Membership writes require the latest value unchanged.

Authentication

AuthorizationBearer

Organization-owned service token. Issue the initial token in organization credential settings. Scopes are documented per operation via x-required-scopes; they are not OAuth scopes.

Path parameters

organization_idstringRequiredformat: "uuid"
Immutable organization UUID bound to the service token.
member_idstringRequiredformat: "uuid"
Immutable user UUID of an active organization membership. Protocol principals and handles are not accepted.

Response headers

X-Request-IdstringOptional
ETagstringOptionalformat: "^"membership-[a-f0-9]{64}"$"
Strong validator for this membership representation and row revision. Membership writes require the latest value unchanged.

Response

Successful operation
idstringformat: "uuid"
organization_idstringformat: "uuid"
display_namestring
handlestring
roleenum
Allowed values:

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error