Get a specific portal user

Get a specific portal user.

Path Parameters

• id uuid required

  Identifies the domain in Keycloak.

• portalUserId uuid required

  Identifies the portal user.

Responses

• 200
• 401
• 403
• 404

---

The portal user was successfully retrieved.

application/json

• Schema
• Example (from schema)

---

Schema

• id uuid

  Id of the portal user.

• createdTimestamp date-time

  When the user was created, specified in ISO 8601.

• enabled boolean

  Sets a user to active if true or inactive if false.

• firstName string

  First name of the portal user.

• lastName string

  Last name of the portal user.

• email string

  Possible values: >= 5 characters and <= 254 characters

  The email address of the portal user.

• phoneNumber string

  Possible values: >= 4 characters and <= 20 characters

  The phone number of the portal user.

• domainId string

  Hierarchical identifier for a domain. Used to identify which domain a user belongs to and whether a user has access to a domain.

• roles object[]

  Contains list of roles.

  id uuid

  Identifies the role.

  name string

  Name of the role.

  description string

  Description of the role.

• domain object

  Contains domain properties.

  id uuid

  Id of the domain in Keycloak. Only used in this API, not to be confused with domainId.

  name string

  Name of the domain.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdTimestamp": "2024-10-17",
  "enabled": true,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phoneNumber": 460760000001,
  "domainId": "abcd1234-efgh1234",
  "roles": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Subscription ordering",
      "description": "Allows user to order new subscriptions and follow up existing orders."
    }
  ],
  "domain": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme"
  }
}

Invalid or missing access token (JWT).

Not authorized to access this resource.

Entity not found.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  Following errors are defined for this service:

  400 Bad Request Errors

  INVALID_REQUEST_BODY

  Request body is invalid. Must contain valid JSON.

  INVALID_EMAIL

  Invalid value for the property email. Must be a valid email.

  INVALID_CLIENT_ID_PREFIX

  Invalid value for the property clientIdPrefix. Allowed characters are A-Z, a-z, 0-9, as well as underscore (_) and hyphen (-). Client id must not be longer than 128 characters.

  NOT_ALLOWED_TO_MANAGE_SELF

  Not allowed to manage your own user.

  INVALID_USER_STATUS

  Invalid value for the property enabled. Boolean values are allowed.

  INVALID_SEARCH_VALUE

  Invalid value for the query parameter search. Most Unicode characters are allowed..

  INVALID_OFFSET_VALUE

  Invalid value for the query parameter offset. Number between 0 and 1000000 is allowed.

  INVALID_LIMIT_VALUE

  Invalid value for the query parameter limit. Number between 0 and 100 is allowed.

  INVALID_ROLES_ARRAY

  Invalid value for the property roles. Must be of type array ([]) containing between 0 and 100 roles.

  INVALID_SOLUTIONS_ARRAY

  Invalid value for the property solutions. Must be of type array ([]) containing between 0 and 100 solutions.

  INVALID_SOLUTION

  Invalid value for one or more entries in the solutions array. Alphabetic characters, numbers, and some special characters are allowed.

  INVALID_USER_ROLES

  Invalid content in property roles. Each role must contain property id with UUID formatting and property type specifying whether the role is global or custom.

  INVALID_SYSTEM_USER_ROLES

  Invalid content in property roles. Each role must contain property id with UUID formatting and property type with value global.

  INVALID_GLOBAL_ROLE

  At least one of the requested global roles is invalid.

  INVALID_NAME

  Invalid value for the property name. Alphabetic characters, numbers, and some special characters are allowed.

  INVALID_PHONE_NUMBER

  Invalid value for the property phoneNumber. Must be of type string containing between 4 and 20 numbers.

  INVALID_PARENT_DOMAIN_ID

  Invalid value for the property parentId. Must contain a string with UUID formatting.

  INVALID_DOMAIN_ID

  Invalid value for the property 'domainId'. Must contain a string.

  PARENT_DOMAIN_NOT_FOUND

  The domain specified in the property parentId could not be found.

  401 Unauthorized Errors

  INVALID_TOKEN

  Access token is not valid.

  403 Forbidden Errors

  FORBIDDEN_ERROR

  Not authorized to access this resource.

  FORBIDDEN_ROLE_UPDATE

  Forbidden operation since it would result in the addition or removal of a role the requesting user does not have themselves.

  FORBIDDEN_IDENTICAL_DOMAIN_UPDATE

  User already belongs to the specified domain.

  FORBIDDEN_SOLUTION

  Forbidden operation since it would result in the addition or removal of a solution the requesting user does not have themselves.

  FORBIDDEN_ROOT_DOMAIN_SOLUTIONS_UPDATE

  Not allowed to change solutions for root domain.

  404 Not Found Errors

  RESOURCE_NOT_FOUND

  Requested resource does not exist.

  409 Conflict Errors

  CONFLICT_ERROR

  Resource already exists.

  500 Internal Server Errors

  SERVICE_ERROR

  Error occurred when communicating with another service. Please try again or contact your system administrator if this problem persists.

  ACCESS_TOKEN_ERROR

  Unexpected error with access token. Please try logging out and in again or contact your system administrator if this problem persists.

  CREATE_DOMAIN_ERROR

  Domain could not be created due to an unexpected internal error. Please try again or contact your system administrator if this problem persists.

  503 Service Unavailable Errors

  CRITICAL_SERVICE_ERROR

  Unable to communicate with another service. Please try again or contact your system administrator if this problem persists.

• timestamp integer

  Epoch timestamp specifying when error occurred

{
  "description": "Requested resource does not exist.",
  "errorCode": "RESOURCE_NOT_FOUND",
  "timestamp": 1560954657369
}

Loading...