How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coder Users API

The Users API from Coder — 28 operation(s) for users.

Coder Users API is one of 32 APIs that Coder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 40 operations across 28 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{coderHost}/api/v2.

40 operations 28 paths 44 schemas 3 DELETE21 GET1 PATCH6 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://coder.example.com/api/v2
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Coder Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Coder-Session-Token (CoderSessionToken). By default, every request must be authenticated.

Paths & Operations 40

Across 28 paths, the API surfaces 40 operations — 3 DELETE, 21 GET, 1 PATCH, 6 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 40
GET
/api/experimental/users/{user}/skills
List user skills
list-user-skills 1 param → 200
POST
/api/experimental/users/{user}/skills
Create a user skill
create-a-user-skill 1 param body → 201
GET
/api/experimental/users/{user}/skills/{skillName}
Get a user skill by name
get-a-user-skill-by-name 2 params → 200
DELETE
/api/experimental/users/{user}/skills/{skillName}
Delete a user skill
delete-a-user-skill 2 params → 204
PATCH
/api/experimental/users/{user}/skills/{skillName}
Update a user skill
update-a-user-skill 2 params body → 200
GET
/api/v2/users
Get users
get-users 4 params → 200
POST
/api/v2/users
Create new user
create-new-user body → 201
GET
/api/v2/users/authmethods
Get authentication methods
get-authentication-methods → 200
GET
/api/v2/users/first
Check initial user created
check-initial-user-created → 200
POST
/api/v2/users/first
Create initial user
create-initial-user body → 201
POST
/api/v2/users/logout
Log out user
log-out-user → 200
GET
/api/v2/users/oauth2/github/callback
OAuth 2.0 GitHub Callback
oauth-20-github-callback → 307
GET
/api/v2/users/oauth2/github/device
Get Github device auth.
get-github-device-auth → 200
GET
/api/v2/users/oidc-claims
Get OIDC claims for the authenticated user
get-oidc-claims-for-the-authenticated-user → 200
GET
/api/v2/users/oidc/callback
OpenID Connect Callback
openid-connect-callback → 307
GET
/api/v2/users/{user}
Get user by name
get-user-by-name 1 param → 200
DELETE
/api/v2/users/{user}
Delete user
delete-user 1 param → 200
GET
/api/v2/users/{user}/appearance
Get user appearance settings
get-user-appearance-settings 1 param → 200
PUT
/api/v2/users/{user}/appearance
Update user appearance settings
update-user-appearance-settings 1 param body → 200
GET
/api/v2/users/{user}/autofill-parameters
Get autofill build parameters for user
get-autofill-build-parameters-for-user 2 params → 200
GET
/api/v2/users/{user}/gitsshkey
Get user Git SSH key
get-user-git-ssh-key 1 param → 200
PUT
/api/v2/users/{user}/gitsshkey
Regenerate user SSH key
regenerate-user-ssh-key 1 param → 200
POST
/api/v2/users/{user}/keys
Create new session key
create-new-session-key 1 param → 201
GET
/api/v2/users/{user}/keys/tokens
Get user tokens
get-user-tokens 2 params → 200
POST
/api/v2/users/{user}/keys/tokens
Create token API key
create-token-api-key 1 param body → 201
GET
/api/v2/users/{user}/keys/tokens/{keyname}
Get API key by token name
get-api-key-by-token-name 2 params → 200
GET
/api/v2/users/{user}/keys/{keyid}
Get API key by ID
get-api-key-by-id 2 params → 200
DELETE
/api/v2/users/{user}/keys/{keyid}
Delete API key
delete-api-key 2 params → 204
PUT
/api/v2/users/{user}/keys/{keyid}/expire
Expire API key
expire-api-key 2 params → 204404500
GET
/api/v2/users/{user}/login-type
Get user login type
get-user-login-type 1 param → 200
GET
/api/v2/users/{user}/organizations
Get organizations by user
get-organizations-by-user 1 param → 200
GET
/api/v2/users/{user}/organizations/{organizationname}
Get organization by user and organization name
get-organization-by-user-and-organization-name 2 params → 200
PUT
/api/v2/users/{user}/password
Update user password
update-user-password 1 param body → 204
GET
/api/v2/users/{user}/preferences
Get user preference settings
get-user-preference-settings 1 param → 200
PUT
/api/v2/users/{user}/preferences
Update user preference settings
update-user-preference-settings 1 param body → 200
PUT
/api/v2/users/{user}/profile
Update user profile
update-user-profile 1 param body → 200
GET
/api/v2/users/{user}/roles
Get user roles
get-user-roles 1 param → 200
PUT
/api/v2/users/{user}/roles
Assign role to user
assign-role-to-user 1 param body → 200
PUT
/api/v2/users/{user}/status/activate
Activate user account
activate-user-account 1 param → 200
PUT
/api/v2/users/{user}/status/suspend
Suspend user account
suspend-user-account 1 param → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are codersdk.User (15 properties), codersdk.APIKey (12 properties), codersdk.CreateUserRequestWithOrgs (9 properties), codersdk.Organization (9 properties). Each schema is shown below with its type and property counts.

codersdk.CreateUserSkillRequest
object
1 property
codersdk.AgentDisplayMode
string
codersdk.CreateUserRequestWithOrgs
object
9 properties 1 required
codersdk.UpdateRoles
object
1 property
codersdk.GetUsersResponse
object
2 properties
codersdk.UserParameter
object
2 properties
codersdk.UpdateUserSkillRequest
object
1 property
codersdk.UserPreferenceSettings
object
5 properties
codersdk.APIKey
object
12 properties 9 required
codersdk.UserAppearanceSettings
object
5 properties
codersdk.GithubAuthMethod
object
2 properties
codersdk.CreateFirstUserTrialInfo
object
7 properties
codersdk.APIKeyScope
string
codersdk.UpdateUserProfileRequest
object
2 properties 1 required
codersdk.Response
object
3 properties
codersdk.CreateFirstUserRequest
object
7 properties 3 required
codersdk.AuthMethods
object
4 properties
codersdk.UserLoginType
object
1 property
codersdk.ExternalAuthDevice
object
5 properties
codersdk.OIDCClaimsResponse
object
1 property
codersdk.OIDCAuthMethod
object
3 properties
codersdk.TerminalFontName
string
codersdk.SlimRole
object
3 properties
codersdk.GenerateAPIKeyResponse
object
1 property
codersdk.CreateFirstUserResponse
object
2 properties
codersdk.ValidationError
object
2 properties 2 required
codersdk.LoginType
string
codersdk.APIAllowListTarget
object
2 properties
codersdk.RBACResource
string
codersdk.UpdateUserPreferenceSettingsRequest
object
5 properties
codersdk.ThemeMode
string
codersdk.AuthMethod
object
1 property
codersdk.UpdateUserPasswordRequest
object
2 properties 1 required
codersdk.AgentChatSendShortcut
string
codersdk.CreateFirstUserOnboardingInfo
object
2 properties
codersdk.UserSkill
object
6 properties
codersdk.UpdateUserAppearanceSettingsRequest
object
5 properties 2 required
codersdk.Organization
object
9 properties 4 required
codersdk.UserStatus
string
codersdk.ThinkingDisplayMode
string
codersdk.CreateTokenRequest
object
5 properties
codersdk.GitSSHKey
object
4 properties
codersdk.User
object
15 properties 4 required
codersdk.UserSkillMetadata
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-users-api-openapi.yml Raw ↑

Other APIs Coder publishes across the network.

Coder Workspaces API
Coder Templates API
Coder Users API
Coder Workspace Agents API
Coder Enterprise API
Coder Agents API
Coder AI Bridge API
Coder AI Providers API
Coder Applications API
Coder Audit API
Coder Authorization API
Coder Builds API
Where this information came from

This is an independent, third-party profile of Coder Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.