Comment on page
Members
A member in GitBook is the entity of a user associated with an organization.
get
https://api.gitbook.com/v1
/orgs/{organizationId}/members
List organization members
Lists members for the specified organization.
Parameters
Path
organizationId*
string
The unique id of the organization
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
role
string
The Role to filter the member list by
search
string
A query to filter the member list (displayName and email)
Responses
200: OK
OK
default
Unexpected Error
get
https://api.gitbook.com/v1
/orgs/{organizationId}/members/{userId}
Get specified organization member
Gets a specific member in an organization.
Parameters
Path
organizationId*
string
The unique id of the organization
userId*
string
The unique ID of the User
Responses
200: OK
OK
default
Unexpected Error
patch
https://api.gitbook.com/v1
/orgs/{organizationId}/members/{userId}
Update specified organization member
Updates a specific member in an organization.
Parameters
Path
organizationId*
string
The unique id of the organization
userId*
string
The unique ID of the User
Body
Example
Schema
{
"role": "admin"
}
Responses
200: OK
The member has been updated
default
Unexpected Error
delete
https://api.gitbook.com/v1
/orgs/{organizationId}/members/{userId}
Delete a member from an organization
Deletes a specific member from an organization
Parameters
Path
organizationId*
string
The unique id of the organization
userId*
string
The unique ID of the User
Responses
204: No Content
The member was deleted from the organization.
default
Unexpected Error
post
https://api.gitbook.com/v1
/orgs/{organizationId}/members/{userId}/sso
Set a user as an SSO member of an organization
Parameters
Path
organizationId*
string
The unique id of the organization
userId*
string
The unique ID of the User
Responses
200: OK
The user has been added as an SSO member of the organization.
default
Unexpected Error
Last modified 7mo ago