GET /api/1/users/{id}
Get User by ID
Returns the user. The `id` is the user's integer id or, modeled, the user's email, which the default roster mapper sends. See https://developers.onelogin.com/api-docs/1/users/get-user-by-id/.
Authentication
[
{
"bearerAuth": []
}
]
Request, responses and operation details
{
"operationId": "getUserById",
"tags": [
"Users"
],
"summary": "Get User by ID",
"description": "Returns the user. The `id` is the user's integer id or, modeled, the user's email, which the default roster mapper sends. See https://developers.onelogin.com/api-docs/1/users/get-user-by-id/.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The user's integer id, or (modeled) the user's email, matched case-insensitively.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEnvelope"
}
}
}
},
"401": {
"description": "Missing or invalid bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unknown user or instance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Instance key locked out (modeled)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal error (modeled)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}