Organization User Groups
8 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/organizations/{organizationIdOrSlug}/user-groups | List user groups in the current organization |
| POST | /api/v1/organizations/{organizationIdOrSlug}/user-groups | Create a user group in the current organization |
| GET | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId} | Retrieve an organization user group |
| PATCH | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId} | Rename an organization user group |
| DELETE | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId} | Delete a user group |
| GET | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members | List members of a user group |
| POST | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members | Add a user to a user group |
| DELETE | /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members/{userId} | Remove a user from a user group |
List user groups in the current organization
GET /api/v1/organizations/{organizationIdOrSlug}/user-groups
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to List user groups in the current organization. |
query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List user groups in the current organization. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List user groups in the current organization. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Create a user group in the current organization
POST /api/v1/organizations/{organizationIdOrSlug}/user-groups
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Create a user group in the current organization. |
Request body
Required — Request body for: Create a user group in the current organization.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
name | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Retrieve an organization user group
GET /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}
Retrieve one user group by its canonical organization locator and ugr_ identifier.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Retrieve an organization user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Retrieve an organization user group. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Rename an organization user group
PATCH /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}
Update the mutable name of one organization user group addressed by its ugr_ identifier.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Rename an organization user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Rename an organization user group. |
Request body
Required — Request body for: Rename an organization user group.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
name | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Delete a user group
DELETE /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Delete a user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Delete a user group. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
List members of a user group
GET /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to List members of a user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to List members of a user group. |
query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List members of a user group. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List members of a user group. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Add a user to a user group
POST /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Add a user to a user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Add a user to a user group. |
Request body
Required — Request body for: Add a user to a user group.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
userId | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Remove a user from a user group
DELETE /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Remove a user from a user group. |
userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Remove a user from a user group. |
userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Remove a user from a user group. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |