Tenancy
Add an organization member
POST /v1/members · SDK addOrganizationMember · CLI deployments member add
POST
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
x-deployments-organization*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
principalId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$role*stringValue in
"admin""billing""member""owner""viewer"OrganizationMemberResponse
application/json- response
createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeupdatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeversion*integerRange
1 <= valuedisplayName?stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 120id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$invitedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timejoinedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeorganizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$primaryEmail?stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
length <= 254principalId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$removedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timerole*stringValue in
"admin""billing""member""owner""viewer"status*stringValue in
"active""invited""removed"curl -X POST "https://example.com/v1/members" \ -H "x-deployments-organization: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "principalId": "string", "role": "admin" }'{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 1, "displayName": "string", "id": "string", "invitedAt": "2019-08-24T14:15:22Z", "joinedAt": "2019-08-24T14:15:22Z", "organizationId": "string", "primaryEmail": "string", "principalId": "string", "removedAt": "2019-08-24T14:15:22Z", "role": "admin", "status": "active"}