Starts a session given a username/password and puts it into a cookie.
Happy response. A set-cookie header will be present.
Deletes all sessions associated with the current user.
Happy response.
Returns all users
Happy response.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Deletes a user.
Successful deletion.
Returns a specific user
Happy response.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Allows updating fields of the user profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Happy response.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Creates a new user.
Sets the unique name of the new user. It must be a valid HQ resource name: it can only contain lowercase alphanumeric characters or hyphens; hyphens cannot appear at the end or start; the length is 63 characters at most.
Sets the display name of the new user. If not provided, the value of "name" will be used.
Allows attaching custom string key/values to resources. The following maxima apply:
Happy response.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates a user.
Updates the display name of the user.
Patches metadata. It has the following semantics:
Happy response.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Assigns the given user exactly to the provided groups, ensuring they are not part of any other groups.
The name of the user.
Adds the user or service account to the groups (specified by their names).
Removes the user or service account from the groups (specified by their names). If a group is specified in both add_to_groups as well in here, removal wins.
Sets the user or service account memberships to those groups (specified by their names) in an absolute fashion (ensures user/sa will be exactly a member of those), if provided. Cannot be combined with the add_to_groups or remove_from_groups.
User groups membership updated successfully.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply:
Returns the currently authenticated user
Happy response.
Represents either a user or service account.
Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.
Contains the resource identifier for use in access control policies.
Contains the resource identifier for use in access control policies.
Is set to the number of users in this group.
Is set to the number of service accounts in this group.
Is set to the number of roles associated with this group.
Allows attaching custom string key/values to resources. The following maxima apply:
Updates when this user has interaction with the API.
Models a user's Profile.
Contains the users' full name, e.g. Mary Jane Doe.
Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.
Allows attaching custom string key/values to resources. The following maxima apply: