Organization API: Customer Portal: Users

The 5 Organization API operations for users.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/users`	List org subusers
POST	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/users`	Add org subuser
POST	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/leave`	A subuser drops their own grant
PUT	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/{subuser_id}`	Update org subuser
DELETE	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/{subuser_id}`	Delete org subuser

List org subusers

Section titled List org subusers

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/users

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add org subuser

Section titled Add org subuser

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/users

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`permissions`	array of string	yes
`username_or_email`	string or null	no
`username`	string or null	no
`email`	string or null	no

Responses

Section titled Responses

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

A subuser drops their own grant

Section titled A subuser drops their own grant

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/leave

A subuser drops their own grant. Owners cannot leave their own server.

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Update org subuser

Section titled Update org subuser

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/{subuser_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`subuser_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`permissions`	array of string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete org subuser

Section titled Delete org subuser

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/users/{subuser_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`subuser_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.