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

Deprecated as of version 2023 Spring. Please use the idm-controller endpoints instead.

As of Version

product version 2021 Summer | component version 

Request MethodGET
Response FormatJSON
Description

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

The role YUUVIS_TENANT_ADMIN is required.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
401 UnauthorizedNot successful.
Request Example

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

no request body

Response Example


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

product version 2021 Summer | component version 

Request MethodGET
Response FormatJSON
Description

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

The role YUUVIS_TENANT_ADMIN is required.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
401 UnauthorizedNot successful.
Request Example

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

no request body

Response Example


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