User

a User in Confighub.

Operations

Method	Endpoint	Description
GET	/user	List Users
GET	/user/{user_id}/key	List an identity's public keys
GET	/user/{user_id}	Get User
POST	/user/{user_id}/key	Register a public key for an identity
DELETE	/user/{user_id}/key/{kid}	Remove a public key from an identity

---

List Users

GET /user

List Users

Operation ID: ListUsers

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Users returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on User: CreatedAt, DisplayName, ExternalID, GroupIDs, HiddenReason, Slug, UpdatedAt, UserID, Username. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the User list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (User). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for User include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for User. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.
include_hidden	string		Hidden User entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
view	string		UUID of a View whose columns to compute for each User, returned as ViewColumns. The View must be in the same Organization as the user credentials, and be a View of User: its Of, or the From of its Filter, must be User. If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
limit	integer		Maximum number of User entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request.
order_by	string		Comma-separated list of fields to sort User results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. Supported attributes for ordering User: CreatedAt, DisplayName, ExternalID, HiddenReason, Slug, UpdatedAt, UserID, Username. Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. Results are ordered by the User's ID after the fields named, and by the ID alone if none are. The whole string must be query-encoded.
continue	string		The token from the ConfigHub-Continue header of the previous page, to return the User entities after it. The request's other parameters, except limit, must be the same as those of the request that returned the token. Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of ExtendedUser
400	User request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	User not found.	application/json	StandardErrorResponse
500	Something went wrong while processing User.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

List an identity's public keys

GET /user/{user_id}/key

List the public keys registered against an identity. Keys are returned unredacted, deliberately: they are public material, and an operator noticing a key nobody registered is how an injected one is caught.

Operation ID: ListUserKeys

Parameters

Path Parameters

Parameter	Type	Required	Description
user_id	string	✓	UUID of the identity whose keys are being managed. For a worker this is its bot user, BridgeWorker.UserID, not the worker's own id.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of UserKey
400	User request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	User not found.	application/json	StandardErrorResponse
500	Something went wrong while processing User.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Get User

GET /user/{user_id}

Get User

Operation ID: GetUser

Parameters

Path Parameters

Parameter	Type	Required	Description
user_id	string	✓	Unique identifier for a user_id

Query Parameters

Parameter	Type	Required	Description
select	string		Select clause for specifying which fields to include in the response for User. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	ExtendedUser
400	User request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	User not found.	application/json	StandardErrorResponse
500	Something went wrong while processing User.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Register a public key for an identity

POST /user/{user_id}/key

Register a public key against an identity. The holder of the matching private key then authenticates by signing a short-lived assertion (RFC 7523 private_key_jwt), so no secret is exchanged and none is stored. Requires the admin or manager role; registering a key for yourself is not permitted.

Operation ID: CreateUserKey

Parameters

Path Parameters

Parameter	Type	Required	Description
user_id	string	✓	UUID of the identity whose keys are being managed. For a worker this is its bot user, BridgeWorker.UserID, not the worker's own id.

Query Parameters

Parameter	Type	Required	Description
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/json

Schema: CreateUserKeyRequest

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	UserKey
400	User request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	User not found.	application/json	StandardErrorResponse
409	User data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing User.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Remove a public key from an identity

DELETE /user/{user_id}/key/{kid}

Remove one registered public key by its thumbprint. This is the second half of rotation, and the response to a compromised private key.

Operation ID: DeleteUserKey

Parameters

Path Parameters

Parameter	Type	Required	Description
user_id	string	✓	UUID of the identity whose keys are being managed. For a worker this is its bot user, BridgeWorker.UserID, not the worker's own id.
kid	string	✓	RFC 7638 thumbprint of the key to remove. The key names itself, so a holder can address it without asking what it was called.

Responses

Status	Description	Content-Type	Schema
200	Response for successful delete operation	application/json	DeleteResponse
400	User request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	User not found.	application/json	StandardErrorResponse
409	User is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read.	application/json	StandardErrorResponse
422	User could not be deleted.	application/json	StandardErrorResponse
500	Something went wrong while processing User.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Schemas

CreateUserKeyRequest

Properties

Property	Type	Required	Description
Description	string
PublicJWK

DeleteResponse

Response for successful delete operation

Properties

Property	Type	Required	Description
Error			Error information if the delete operation failed.
Message	string		Response message.

ExtendedUser

Properties

Property	Type	Required	Description
Error	ResponseError
User	User
ViewColumns	Array of ViewColumn		The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name.

StandardErrorResponse

The body of an error response: the error as data (Error), and as one string (message) for clients written before Error.

Properties

Property	Type	Required	Description
Error			The error: its message, category (Type), HTTP status, details, and structured items.
message	string		The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error.

UserKey

Properties

Property	Type	Required	Description
CreatedAt	string (date-time)
Description	string
ExpiresAt	string (date-time)
Kid	string
LastUsedAt	string (date-time)
PublicJWK
UserID	string (uuid)
UserKeyID	string (uuid)