Get User Attributes

Overview

Use this API to retrieve metadata for custom attributes of user resource.

SecurityoAuthUser or oAuthClient
Request
query Parameters
$attribute
required
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Available values: all, custom

Examples:
Attributes 'custom' are returned in the server response.
$attribute=custom
All the attributes are returned in the server response.
$attribute=all
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204
  • No content to return. For example, if custom attributes are requested, and no custom attributes are defined for the user resource.
400

Bad Request

401

Unauthorized

403

Forbidden

406

Not Acceptable

500

Internal server error

get/user/attributes
Request samples
Response samples
application/json
    

  • This example demonstrates the following:
      

    • Getting the metadata for custom attributes of user resource. Note that the response is the same even if the value of $attribute is "all".
      • 

    

    • 

  • GET /core/usermgr/v3/user/attributes?$attribute=custom
    • 



{
  • "attribute": [
    ],
  • "resource": "user"
}