Members

Get a member

get

Returns details for a specific organization member, including their roles.

Authorizations
AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters
memberIdintegerRequired

The user ID of the member

Responses
chevron-right
200

Member details

application/json
user_idintegerOptional
usernamestringOptional
rolesstring[]Optional
is_ownerbooleanOptional
created_atstring · date-timeOptional
get
/v1/members/{memberId}

Remove a member

delete

Removes a member from the organization. Organization owners cannot be removed.

Authorizations
AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters
memberIdintegerRequired

The user ID of the member

Responses
delete
/v1/members/{memberId}

No content

Update a member's roles

patch

Updates the roles assigned to a specific organization member. Organization owners cannot have their roles modified.

Authorizations
AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters
memberIdintegerRequired

The user ID of the member

Body
rolesstring[]Required

New roles to assign to the member

Responses
chevron-right
200

Member roles updated successfully

application/json
user_idintegerOptional
usernamestringOptional
rolesstring[]Optional
created_atstring · date-timeOptional
patch
/v1/members/{memberId}

List organization members

get

Returns all members of the authenticated organization.

Authorizations
AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Responses
chevron-right
200

List of organization members

application/json
get
/v1/members

Add a member

post

Adds a new member to the organization with the specified roles.

Authorizations
AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Body
usernamestringRequired

The username of the user to add

rolesstring[]Optional

Roles to assign to the new member

Default: ["member"]
Responses
post
/v1/members

Last updated

Was this helpful?