2026-08-11 11:22:55 -04:00
---
# Code generated by make gen. DO NOT EDIT.
title : Members
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
2023-01-11 12:16:09 +01:00
2024-06-12 09:52:18 -10:00
## List organization members
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2024-06-12 09:52:18 -10:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{ organization} /members \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/organizations/{organization}/members`
2024-06-12 09:52:18 -10:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------|----------|-----------------|
2024-06-12 09:52:18 -10:00
| `organization` | path | string | true | Organization ID |
### Example responses
> 200 Response
```json
[
2025-01-03 18:12:59 +05:00
{
"avatar_url" : "string" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "string" ,
"global_roles" : [
{
"display_name" : "string" ,
"name" : "string" ,
"organization_id" : "string"
}
],
2026-03-26 17:36:40 +07:00
"has_ai_seat" : true ,
2026-03-24 10:13:25 -08:00
"is_service_account" : true ,
2026-03-21 16:58:45 -08:00
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"login_type" : "" ,
2025-01-03 18:12:59 +05:00
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"roles" : [
{
"display_name" : "string" ,
"name" : "string" ,
"organization_id" : "string"
}
],
2026-03-21 16:58:45 -08:00
"status" : "active" ,
2025-01-03 18:12:59 +05:00
"updated_at" : "2019-08-24T14:15:22Z" ,
2026-03-21 16:58:45 -08:00
"user_created_at" : "2019-08-24T14:15:22Z" ,
2025-01-03 18:12:59 +05:00
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5" ,
2026-03-21 16:58:45 -08:00
"user_updated_at" : "2019-08-24T14:15:22Z" ,
2025-01-03 18:12:59 +05:00
"username" : "string"
}
2024-06-12 09:52:18 -10:00
]
```
### Responses
2024-07-16 12:25:36 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------|
2024-07-16 12:25:36 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | array of [codersdk.OrganizationMemberWithUserData ](schemas.md#codersdkorganizationmemberwithuserdata ) |
2024-06-12 09:52:18 -10:00
<h3 id="list-organization-members-responseschema">Response Schema</h3>
Status Code **200**
2026-03-26 17:36:40 +07:00
| Name | Type | Required | Restrictions | Description |
|------------------------|------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | |
| `» avatar_url` | string | false | | |
| `» created_at` | string(date-time) | false | | |
| `» email` | string | false | | |
| `» global_roles` | array | false | | |
| `»» display_name` | string | false | | |
| `»» name` | string | false | | |
| `»» organization_id` | string | false | | |
| `» has_ai_seat` | boolean | false | | Has ai seat intentionally omits omitempty so the API always includes the field, even when false. |
| `» is_service_account` | boolean | false | | |
| `» last_seen_at` | string(date-time) | false | | |
| `» login_type` | [codersdk.LoginType ](schemas.md#codersdklogintype ) | false | | |
| `» name` | string | false | | |
| `» organization_id` | string(uuid) | false | | |
| `» roles` | array | false | | |
| `» status` | [codersdk.UserStatus ](schemas.md#codersdkuserstatus ) | false | | |
| `» updated_at` | string(date-time) | false | | |
| `» user_created_at` | string(date-time) | false | | |
| `» user_id` | string(uuid) | false | | |
| `» user_updated_at` | string(date-time) | false | | |
| `» username` | string | false | | |
2026-03-21 16:58:45 -08:00
#### Enumerated Values
| Property | Value(s) |
|--------------|---------------------------------------------------|
| `login_type` | ``, ` github`, ` none`, ` oidc`, ` password`, ` token` |
| ` status` | ` active`, ` suspended` |
2024-06-12 09:52:18 -10:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2023-01-11 12:16:09 +01:00
## Get member roles by organization
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2023-01-11 12:16:09 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` GET /api/v2/organizations/{organization}/members/roles`
2023-01-11 12:16:09 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------------|----------|-----------------|
2023-01-11 12:16:09 +01:00
| ` organization` | path | string(uuid) | true | Organization ID |
### Example responses
> 200 Response
` ``json
[
2025-01-03 18:12:59 +05:00
{
"assignable": true,
"built_in": true,
"display_name": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
}
2023-01-11 12:16:09 +01:00
]
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
2023-01-11 12:16:09 +01:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) |
<h3 id="get-member-roles-by-organization-responseschema">Response Schema</h3>
Status Code **200**
2025-10-27 17:14:16 -06:00
| Name | Type | Required | Restrictions | Description |
|-------------------------------------|----------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » assignable` | boolean | false | | |
| ` » built_in` | boolean | false | | Built in roles are immutable |
| ` » display_name` | string | false | | |
| ` » name` | string | false | | |
| ` » organization_id` | string(uuid) | false | | |
| ` » organization_member_permissions` | array | false | | Organization member permissions are specific for the organization in the field 'OrganizationID' above. |
| ` »» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | |
| ` »» negate` | boolean | false | | Negate makes this a negative permission |
| ` »» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | |
| ` » organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. |
| ` » site_permissions` | array | false | | |
| ` » user_permissions` | array | false | | |
2024-05-29 09:49:43 -05:00
#### Enumerated Values
2026-08-24 10:43:45 +01:00
| Property | Value(s) |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` action` | ` application_connect`, ` assign`, ` create`, ` create_agent`, ` delete`, ` delete_agent`, ` read`, ` read_personal`, ` share`, ` ssh`, ` start`, ` stop`, ` unassign`, ` update`, ` update_agent`, ` update_personal`, ` use`, ` view_insights` |
| ` resource_type` | ` *`, ` ai_gateway_key`, ` ai_model_price`, ` ai_provider`, ` ai_seat`, ` aibridge_interception`, ` api_key`, ` assign_org_role`, ` assign_role`, ` audit_log`, ` boundary_log`, ` boundary_usage`, ` chat`, ` chat_model_config`, ` connection_log`, ` crypto_key`, ` debug_info`, ` deployment_config`, ` deployment_stats`, ` file`, ` group`, ` group_member`, ` idpsync_settings`, ` inbox_notification`, ` license`, ` mcp_server_config`, ` notification_message`, ` notification_preference`, ` notification_template`, ` oauth2_app`, ` oauth2_app_code_token`, ` oauth2_app_secret`, ` organization`, ` organization_member`, ` prebuilt_workspace`, ` provisioner_daemon`, ` provisioner_jobs`, ` replicas`, ` system`, ` tailnet_coordinator`, ` task`, ` template`, ` usage_event`, ` user`, ` user_secret`, ` user_skill`, ` webpush_subscription`, ` workspace`, ` workspace_agent_devcontainers`, ` workspace_agent_resource_monitor`, ` workspace_build_orchestration`, ` workspace_dormant`, ` workspace_proxy` |
2024-05-29 09:49:43 -05:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2026-01-12 18:19:19 -08:00
## Update a custom organization role
2024-05-29 09:49:43 -05:00
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2024-05-29 09:49:43 -05:00
# Example request using curl
2024-08-13 12:53:47 -05:00
curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
2024-08-05 13:42:11 -05:00
-H 'Content-Type: application/json' \
2024-05-29 09:49:43 -05:00
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` PUT /api/v2/organizations/{organization}/members/roles`
2024-05-29 09:49:43 -05:00
2024-08-05 13:42:11 -05:00
> Body parameter
` ``json
{
2025-01-03 18:12:59 +05:00
"display_name": "string",
"name": "string",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
2024-08-05 13:42:11 -05:00
}
` ``
2024-05-29 09:49:43 -05:00
### Parameters
2024-08-13 12:53:47 -05:00
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------------------------------------------------------------------|----------|---------------------|
2024-08-13 12:53:47 -05:00
| ` organization` | path | string(uuid) | true | Organization ID |
2026-01-12 18:19:19 -08:00
| ` body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Update role request |
2024-05-29 09:49:43 -05:00
### Example responses
> 200 Response
` ``json
[
2025-01-03 18:12:59 +05:00
{
"display_name": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
}
2024-05-29 09:49:43 -05:00
]
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|---------------------------------------------------|
2024-05-29 09:49:43 -05:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
2026-01-12 18:19:19 -08:00
<h3 id="update-a-custom-organization-role-responseschema">Response Schema</h3>
2024-05-29 09:49:43 -05:00
Status Code **200**
2025-10-27 17:14:16 -06:00
| Name | Type | Required | Restrictions | Description |
|-------------------------------------|----------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » display_name` | string | false | | |
| ` » name` | string | false | | |
| ` » organization_id` | string(uuid) | false | | |
| ` » organization_member_permissions` | array | false | | Organization member permissions are specific for the organization in the field 'OrganizationID' above. |
| ` »» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | |
| ` »» negate` | boolean | false | | Negate makes this a negative permission |
| ` »» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | |
| ` » organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. |
| ` » site_permissions` | array | false | | |
| ` » user_permissions` | array | false | | |
2024-08-13 12:53:47 -05:00
#### Enumerated Values
2026-08-24 10:43:45 +01:00
| Property | Value(s) |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` action` | ` application_connect`, ` assign`, ` create`, ` create_agent`, ` delete`, ` delete_agent`, ` read`, ` read_personal`, ` share`, ` ssh`, ` start`, ` stop`, ` unassign`, ` update`, ` update_agent`, ` update_personal`, ` use`, ` view_insights` |
| ` resource_type` | ` *`, ` ai_gateway_key`, ` ai_model_price`, ` ai_provider`, ` ai_seat`, ` aibridge_interception`, ` api_key`, ` assign_org_role`, ` assign_role`, ` audit_log`, ` boundary_log`, ` boundary_usage`, ` chat`, ` chat_model_config`, ` connection_log`, ` crypto_key`, ` debug_info`, ` deployment_config`, ` deployment_stats`, ` file`, ` group`, ` group_member`, ` idpsync_settings`, ` inbox_notification`, ` license`, ` mcp_server_config`, ` notification_message`, ` notification_preference`, ` notification_template`, ` oauth2_app`, ` oauth2_app_code_token`, ` oauth2_app_secret`, ` organization`, ` organization_member`, ` prebuilt_workspace`, ` provisioner_daemon`, ` provisioner_jobs`, ` replicas`, ` system`, ` tailnet_coordinator`, ` task`, ` template`, ` usage_event`, ` user`, ` user_secret`, ` user_skill`, ` webpush_subscription`, ` workspace`, ` workspace_agent_devcontainers`, ` workspace_agent_resource_monitor`, ` workspace_build_orchestration`, ` workspace_dormant`, ` workspace_proxy` |
2024-08-13 12:53:47 -05:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Insert a custom organization role
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2024-08-13 12:53:47 -05:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` POST /api/v2/organizations/{organization}/members/roles`
2024-08-13 12:53:47 -05:00
> Body parameter
` ``json
{
2025-01-03 18:12:59 +05:00
"display_name": "string",
"name": "string",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
2024-08-13 12:53:47 -05:00
}
` ``
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------------------------------------------------------------------|----------|---------------------|
2024-08-13 12:53:47 -05:00
| ` organization` | path | string(uuid) | true | Organization ID |
| ` body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Insert role request |
### Example responses
> 200 Response
` ``json
[
2025-01-03 18:12:59 +05:00
{
"display_name": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
}
2024-08-13 12:53:47 -05:00
]
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|---------------------------------------------------|
2024-08-13 12:53:47 -05:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
<h3 id="insert-a-custom-organization-role-responseschema">Response Schema</h3>
Status Code **200**
2025-10-27 17:14:16 -06:00
| Name | Type | Required | Restrictions | Description |
|-------------------------------------|----------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » display_name` | string | false | | |
| ` » name` | string | false | | |
| ` » organization_id` | string(uuid) | false | | |
| ` » organization_member_permissions` | array | false | | Organization member permissions are specific for the organization in the field 'OrganizationID' above. |
| ` »» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | |
| ` »» negate` | boolean | false | | Negate makes this a negative permission |
| ` »» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | |
| ` » organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. |
| ` » site_permissions` | array | false | | |
| ` » user_permissions` | array | false | | |
2024-08-07 12:37:55 -05:00
#### Enumerated Values
2026-08-24 10:43:45 +01:00
| Property | Value(s) |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` action` | ` application_connect`, ` assign`, ` create`, ` create_agent`, ` delete`, ` delete_agent`, ` read`, ` read_personal`, ` share`, ` ssh`, ` start`, ` stop`, ` unassign`, ` update`, ` update_agent`, ` update_personal`, ` use`, ` view_insights` |
| ` resource_type` | ` *`, ` ai_gateway_key`, ` ai_model_price`, ` ai_provider`, ` ai_seat`, ` aibridge_interception`, ` api_key`, ` assign_org_role`, ` assign_role`, ` audit_log`, ` boundary_log`, ` boundary_usage`, ` chat`, ` chat_model_config`, ` connection_log`, ` crypto_key`, ` debug_info`, ` deployment_config`, ` deployment_stats`, ` file`, ` group`, ` group_member`, ` idpsync_settings`, ` inbox_notification`, ` license`, ` mcp_server_config`, ` notification_message`, ` notification_preference`, ` notification_template`, ` oauth2_app`, ` oauth2_app_code_token`, ` oauth2_app_secret`, ` organization`, ` organization_member`, ` prebuilt_workspace`, ` provisioner_daemon`, ` provisioner_jobs`, ` replicas`, ` system`, ` tailnet_coordinator`, ` task`, ` template`, ` usage_event`, ` user`, ` user_secret`, ` user_skill`, ` webpush_subscription`, ` workspace`, ` workspace_agent_devcontainers`, ` workspace_agent_resource_monitor`, ` workspace_build_orchestration`, ` workspace_dormant`, ` workspace_proxy` |
2024-08-07 12:37:55 -05:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Delete a custom organization role
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2024-08-07 12:37:55 -05:00
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/members/roles/{roleName} \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` DELETE /api/v2/organizations/{organization}/members/roles/{roleName}`
2024-08-07 12:37:55 -05:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------------|----------|-----------------|
2024-08-07 12:37:55 -05:00
| ` organization` | path | string(uuid) | true | Organization ID |
| ` roleName` | path | string | true | Role name |
### Example responses
> 200 Response
` ``json
[
2025-01-03 18:12:59 +05:00
{
"display_name": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
}
2024-08-07 12:37:55 -05:00
]
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|---------------------------------------------------|
2024-08-07 12:37:55 -05:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
<h3 id="delete-a-custom-organization-role-responseschema">Response Schema</h3>
Status Code **200**
2025-10-27 17:14:16 -06:00
| Name | Type | Required | Restrictions | Description |
|-------------------------------------|----------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » display_name` | string | false | | |
| ` » name` | string | false | | |
| ` » organization_id` | string(uuid) | false | | |
| ` » organization_member_permissions` | array | false | | Organization member permissions are specific for the organization in the field 'OrganizationID' above. |
| ` »» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | |
| ` »» negate` | boolean | false | | Negate makes this a negative permission |
| ` »» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | |
| ` » organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. |
| ` » site_permissions` | array | false | | |
| ` » user_permissions` | array | false | | |
2024-05-21 13:14:00 -05:00
#### Enumerated Values
2026-08-24 10:43:45 +01:00
| Property | Value(s) |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` action` | ` application_connect`, ` assign`, ` create`, ` create_agent`, ` delete`, ` delete_agent`, ` read`, ` read_personal`, ` share`, ` ssh`, ` start`, ` stop`, ` unassign`, ` update`, ` update_agent`, ` update_personal`, ` use`, ` view_insights` |
| ` resource_type` | ` *`, ` ai_gateway_key`, ` ai_model_price`, ` ai_provider`, ` ai_seat`, ` aibridge_interception`, ` api_key`, ` assign_org_role`, ` assign_role`, ` audit_log`, ` boundary_log`, ` boundary_usage`, ` chat`, ` chat_model_config`, ` connection_log`, ` crypto_key`, ` debug_info`, ` deployment_config`, ` deployment_stats`, ` file`, ` group`, ` group_member`, ` idpsync_settings`, ` inbox_notification`, ` license`, ` mcp_server_config`, ` notification_message`, ` notification_preference`, ` notification_template`, ` oauth2_app`, ` oauth2_app_code_token`, ` oauth2_app_secret`, ` organization`, ` organization_member`, ` prebuilt_workspace`, ` provisioner_daemon`, ` provisioner_jobs`, ` replicas`, ` system`, ` tailnet_coordinator`, ` task`, ` template`, ` usage_event`, ` user`, ` user_secret`, ` user_skill`, ` webpush_subscription`, ` workspace`, ` workspace_agent_devcontainers`, ` workspace_agent_resource_monitor`, ` workspace_build_orchestration`, ` workspace_dormant`, ` workspace_proxy` |
2023-01-11 12:16:09 +01:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2026-02-03 12:48:25 -06:00
## Get organization member
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2026-02-03 12:48:25 -06:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` GET /api/v2/organizations/{organization}/members/{user}`
2026-02-03 12:48:25 -06:00
### Parameters
| Name | In | Type | Required | Description |
|----------------|------|--------|----------|----------------------|
| ` organization` | path | string | true | Organization ID |
| ` user` | path | string | true | User ID, name, or me |
### Example responses
> 200 Response
` ``json
{
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"global_roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
2026-03-26 17:36:40 +07:00
"has_ai_seat": true,
2026-03-24 10:13:25 -08:00
"is_service_account": true,
2026-03-21 16:58:45 -08:00
"last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "",
2026-02-03 12:48:25 -06:00
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
2026-03-21 16:58:45 -08:00
"status": "active",
2026-02-03 12:48:25 -06:00
"updated_at": "2019-08-24T14:15:22Z",
2026-03-21 16:58:45 -08:00
"user_created_at": "2019-08-24T14:15:22Z",
2026-02-03 12:48:25 -06:00
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
2026-03-21 16:58:45 -08:00
"user_updated_at": "2019-08-24T14:15:22Z",
2026-02-03 12:48:25 -06:00
"username": "string"
}
` ``
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMemberWithUserData](schemas.md#codersdkorganizationmemberwithuserdata) |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2024-06-20 04:19:24 -10:00
## Add organization member
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2024-06-20 04:19:24 -10:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` POST /api/v2/organizations/{organization}/members/{user}`
2024-06-20 04:19:24 -10:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------|----------|----------------------|
2024-06-20 04:19:24 -10:00
| ` organization` | path | string | true | Organization ID |
| ` user` | path | string | true | User ID, name, or me |
### Example responses
> 200 Response
2024-06-20 05:06:37 -10:00
` ``json
{
2025-01-03 18:12:59 +05:00
"created_at": "2019-08-24T14:15:22Z",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
2024-06-20 05:06:37 -10:00
}
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
2024-06-20 05:06:37 -10:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Remove organization member
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2024-06-20 05:06:37 -10:00
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` DELETE /api/v2/organizations/{organization}/members/{user}`
2024-06-20 05:06:37 -10:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------|----------|----------------------|
2024-06-20 05:06:37 -10:00
| ` organization` | path | string | true | Organization ID |
| ` user` | path | string | true | User ID, name, or me |
2024-06-20 04:19:24 -10:00
### Responses
2024-07-16 12:25:36 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|-----------------------------------------------------------------|-------------|--------|
2024-07-16 12:25:36 -06:00
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
2024-06-20 04:19:24 -10:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2023-01-11 12:16:09 +01:00
## Assign role to organization member
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2023-01-11 12:16:09 +01:00
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members/{user}/roles \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` PUT /api/v2/organizations/{organization}/members/{user}/roles`
2023-01-11 12:16:09 +01:00
> Body parameter
` ``json
{
2025-01-03 18:12:59 +05:00
"roles": [
"string"
]
2023-01-11 12:16:09 +01:00
}
` ``
### Parameters
2023-01-11 14:08:04 +01:00
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------------|------|--------------------------------------------------------|----------|----------------------|
2023-01-11 14:08:04 +01:00
| ` organization` | path | string | true | Organization ID |
| ` user` | path | string | true | User ID, name, or me |
| ` body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request |
2023-01-11 12:16:09 +01:00
### Example responses
> 200 Response
` ``json
{
2025-01-03 18:12:59 +05:00
"created_at": "2019-08-24T14:15:22Z",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
2023-01-11 12:16:09 +01:00
}
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
2023-01-11 12:16:09 +01:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2023-01-11 14:08:04 +01:00
2025-03-10 14:42:07 -04:00
## Paginated organization members
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2025-03-10 14:42:07 -04:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/paginated-members \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` GET /api/v2/organizations/{organization}/paginated-members`
2025-03-10 14:42:07 -04:00
### Parameters
2026-03-21 16:58:45 -08:00
| Name | In | Type | Required | Description |
|----------------|-------|--------------|----------|--------------------------------------|
| ` organization` | path | string | true | Organization ID |
| ` q` | query | string | false | Member search query |
| ` after_id` | query | string(uuid) | false | After ID |
| ` limit` | query | integer | false | Page limit, if 0 returns all members |
| ` offset` | query | integer | false | Page offset |
2025-03-10 14:42:07 -04:00
### Example responses
> 200 Response
` ``json
[
{
"count": 0,
"members": [
{
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"global_roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
2026-03-26 17:36:40 +07:00
"has_ai_seat": true,
2026-03-24 10:13:25 -08:00
"is_service_account": true,
2026-03-21 16:58:45 -08:00
"last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "",
2025-03-10 14:42:07 -04:00
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"roles": [
{
"display_name": "string",
"name": "string",
"organization_id": "string"
}
],
2026-03-21 16:58:45 -08:00
"status": "active",
2025-03-10 14:42:07 -04:00
"updated_at": "2019-08-24T14:15:22Z",
2026-03-21 16:58:45 -08:00
"user_created_at": "2019-08-24T14:15:22Z",
2025-03-10 14:42:07 -04:00
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
2026-03-21 16:58:45 -08:00
"user_updated_at": "2019-08-24T14:15:22Z",
2025-03-10 14:42:07 -04:00
"username": "string"
}
]
}
]
` ``
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.PaginatedMembersResponse](schemas.md#codersdkpaginatedmembersresponse) |
<h3 id="paginated-organization-members-responseschema">Response Schema</h3>
Status Code **200**
2026-03-26 17:36:40 +07:00
| Name | Type | Required | Restrictions | Description |
|-------------------------|------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » count` | integer | false | | |
| ` » members` | array | false | | |
| ` »» avatar_url` | string | false | | |
| ` »» created_at` | string(date-time) | false | | |
| ` »» email` | string | false | | |
| ` »» global_roles` | array | false | | |
| ` »»» display_name` | string | false | | |
| ` »»» name` | string | false | | |
| ` »»» organization_id` | string | false | | |
| ` »» has_ai_seat` | boolean | false | | Has ai seat intentionally omits omitempty so the API always includes the field, even when false. |
| ` »» is_service_account` | boolean | false | | |
| ` »» last_seen_at` | string(date-time) | false | | |
| ` »» login_type` | [codersdk.LoginType](schemas.md#codersdklogintype) | false | | |
| ` »» name` | string | false | | |
| ` »» organization_id` | string(uuid) | false | | |
| ` »» roles` | array | false | | |
| ` »» status` | [codersdk.UserStatus](schemas.md#codersdkuserstatus) | false | | |
| ` »» updated_at` | string(date-time) | false | | |
| ` »» user_created_at` | string(date-time) | false | | |
| ` »» user_id` | string(uuid) | false | | |
| ` »» user_updated_at` | string(date-time) | false | | |
| ` »» username` | string | false | | |
2026-03-21 16:58:45 -08:00
#### Enumerated Values
| Property | Value(s) |
|--------------|---------------------------------------------------|
| ` login_type` | ``, ` github`, ` none`, ` oidc`, ` password`, ` token` |
| ` status` | ` active`, ` suspended` |
2025-03-10 14:42:07 -04:00
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2023-01-11 14:08:04 +01:00
## Get site member roles
### Code samples
2026-07-15 14:07:09 -04:00
` ``sh
2023-01-11 14:08:04 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/roles \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
` ``
2026-05-05 02:54:03 +05:00
` GET /api/v2/users/roles`
2023-01-11 14:08:04 +01:00
### Example responses
> 200 Response
` ``json
[
2025-01-03 18:12:59 +05:00
{
"assignable": true,
"built_in": true,
"display_name": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2025-10-27 17:14:16 -06:00
"organization_member_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
2025-01-03 18:12:59 +05:00
"organization_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"site_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
],
"user_permissions": [
{
"action": "application_connect",
"negate": true,
"resource_type": "*"
}
]
}
2023-01-11 14:08:04 +01:00
]
` ``
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
2023-01-11 14:08:04 +01:00
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) |
<h3 id="get-site-member-roles-responseschema">Response Schema</h3>
Status Code **200**
2025-10-27 17:14:16 -06:00
| Name | Type | Required | Restrictions | Description |
|-------------------------------------|----------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------|
| ` [array item]` | array | false | | |
| ` » assignable` | boolean | false | | |
| ` » built_in` | boolean | false | | Built in roles are immutable |
| ` » display_name` | string | false | | |
| ` » name` | string | false | | |
| ` » organization_id` | string(uuid) | false | | |
| ` » organization_member_permissions` | array | false | | Organization member permissions are specific for the organization in the field 'OrganizationID' above. |
| ` »» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | |
| ` »» negate` | boolean | false | | Negate makes this a negative permission |
| ` »» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | |
| ` » organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. |
| ` » site_permissions` | array | false | | |
| ` » user_permissions` | array | false | | |
2024-05-16 13:47:47 -05:00
#### Enumerated Values
2026-08-24 10:43:45 +01:00
| Property | Value(s) |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` action` | ` application_connect`, ` assign`, ` create`, ` create_agent`, ` delete`, ` delete_agent`, ` read`, ` read_personal`, ` share`, ` ssh`, ` start`, ` stop`, ` unassign`, ` update`, ` update_agent`, ` update_personal`, ` use`, ` view_insights` |
| ` resource_type` | ` *`, ` ai_gateway_key`, ` ai_model_price`, ` ai_provider`, ` ai_seat`, ` aibridge_interception`, ` api_key`, ` assign_org_role`, ` assign_role`, ` audit_log`, ` boundary_log`, ` boundary_usage`, ` chat`, ` chat_model_config`, ` connection_log`, ` crypto_key`, ` debug_info`, ` deployment_config`, ` deployment_stats`, ` file`, ` group`, ` group_member`, ` idpsync_settings`, ` inbox_notification`, ` license`, ` mcp_server_config`, ` notification_message`, ` notification_preference`, ` notification_template`, ` oauth2_app`, ` oauth2_app_code_token`, ` oauth2_app_secret`, ` organization`, ` organization_member`, ` prebuilt_workspace`, ` provisioner_daemon`, ` provisioner_jobs`, ` replicas`, ` system`, ` tailnet_coordinator`, ` task`, ` template`, ` usage_event`, ` user`, ` user_secret`, ` user_skill`, ` webpush_subscription`, ` workspace`, ` workspace_agent_devcontainers`, ` workspace_agent_resource_monitor`, ` workspace_build_orchestration`, ` workspace_dormant`, ` workspace_proxy` |
2024-05-16 13:47:47 -05:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).