Location
/api/apps/{appID}/users/{userID}/display-name
This resource represents the name to display for the
current user.
Request Headers (Applies to all methods)
Authorization
header
Required: Yes
GET
/api/apps/{appID}/users/{userID}/display-name
Description
Get the display name.
Security
An anonymous access to this method is not allowed.
Name
Required?
type
Description
Authorization
Yes
string
Authorization header. OAuth2 Bearer token
Responses
200
Content-Type text/plain
The display name has been retrieved successfully.
404
Content-Type application/vnd.kii.UserNotFoundException+json
The user was not found.
Contents
| Name | Type | Description |
|---|---|---|
| errorCode | string | Error code "USER_NOT_FOUND". |
| message | string | The error message. |
| field | string | The field used for searching the user. This can be the userID or address field. |
| value | string | The field value used for searching the user. |
| appID | string | The ID of the application. |
404
Content-Type application/vnd.kii.UserWithoutDisplayNameException+json
The user did not have any value in the field "displayName".
Contents
| Name | Type | Description |
|---|---|---|
| errorCode | string | Error code "USER_DISPLAY_NAME_NOT_FOUND". |
| message | string | The error message. |
| userID | string | The ID of the user. |
| appID | string | The ID of the application. |
401
Content-Type application/vnd.kii.UnauthorizedAccessException+json
An anonymous access was not allowed.
Contents
| Name | Type | Description |
|---|---|---|
| errorCode | string | Error code "UNAUTHORIZED". |
| message | string | The error message. |
| authenticatedAppID | string | The authenticated appID. |
| authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |