Docs

Start here

Change a member's role

POST/v1/studio/projects/{project}/members/{member}on https://api.auray.ai/v1

Give a member another role.

Give a member another role. The owner gives any role but their own; an admin gives a collaborator's or a viewer's, never another admin's; nobody changes their own. The member is told. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — a key with the scope the route names.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes
memberstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
rolestringyes—One of "admin", "collaborator", "viewer".

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/members/… \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "role": "collaborator"
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "member".
idstringyes—
rolestringyes—One of "owner", "admin", "collaborator", "viewer".
selfbooleanyes—
namestringyes—May be null.
handlestringyes—May be null.
avatar_urlstringyes—A URL. May be null.
joined_atstringyes—
room_epochintegerno—On the reader's own row only: the epoch the project's Realtime topics are named with now (studio:<project>:<epoch>:<channel>). It moves whenever somebody leaves the project or loses a capability, and a window joins its channels again with the new one. 0 to ….
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
413Payload Too Large
429Too Many Requests
500Internal Server Error
503Service Unavailable

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close