GET /api-web/api/idm/users/{userId}

As of Version

product version 2023 Spring

Request Method GET

Response Format JSON

Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service

Description

Retrieves user-specific data for the user specified by userId.

Response HTTP status codes:

HTTP Status Code	Meaning
`200 OK`	Successful.
`401 Unauthorized`	Not successful.

Request Example

https://<host>/api-web/api/idm/users/{userId}

no request body

Response Example

{
  "username": "string",
  "id": "string",
  "foreignid": "string",
  "type": "string",
  "title": "string",
  "email": "string",
  "firstname": "string",
  "lastname": "string",
  "domain": "string",
  "tenant": "string",
  "authorities": [
    "string"
  ],
  "substituteOf": [
    "string"
  ],
  "accountNonExpired": true,
  "accountNonLocked": true,
  "credentialsNonExpired": true,
  "enabled": true,
  "displayName": "string"
}