Skip to content

User Info

Operations

Method Endpoint Description
GET /me Get the current user's information

Get the current user's information

GET /me

Get the current user's information

Operation ID: GetMe

Responses

Status Description Content-Type Schema
200 a User given membership on the Organization application/json OrganizationMember
400 UserInfo request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 UserInfo not found. application/json StandardErrorResponse
500 Something went wrong while processing UserInfo. application/json StandardErrorResponse
default a User given membership on the Organization application/json OrganizationMember

Schemas

OrganizationMember

a User given membership on the Organization

Properties

Property Type Required Description
DisplayName string Friendly name for the organization member User.
ExternalID string Unique identifier for the External Identity Provider record matching this User.
ExternalOrganizationID string Unique identifier for the External Identity Provider record matching this organization.
OrganizationID string (uuid) Unique identifier for an organization.
ProfilePictureURL string The URL to get the profile avatar picture of the User.
Slug string Unique URL-safe identifier for the organization member User.
UserID string (uuid) Unique identifier for the organization member User.
Username string Unique username for a User. Must be unique for all of ConfigHub.

StandardErrorResponse

Error response details.

Properties

Property Type Required Description
Code string HTTP status code of the response.
Message string Message returned with the response.