POST Identity/ReadAttribute

Returns an array of attributes for the requested person or group's identity. The caller is not required to have any special permissions.

Requirements

  • Permissions:  The caller is not required to have any special permissions.
  • Token scope:  Configuration

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

AttributeName

The attribute that describes a person or group:

  • For a Group: specify Group Membership.
  • For an individual identity, specify one of the following: Full Name, Internet EMail Address ,Given Name, Surname.

ID

Identity Information that describes a user or group. To get this information, call POST Identity/Browse or the UI.

Returns

Response description

Name

Description

AttributeNames

An array of ID attribute values or an empty array if no ID attributes were stored.

Example: Find information about an identity

Request

POST https://tpp.venafi.example/vedsdk/Identity/ReadAttribute
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ID":{
      "PrefixedName":"AD+venqa:bsupport"
   },
   "AttributeName":"Surname"
}

Response

HTTP/1.1 200 OK
{
   "Attributes":[
      "support"
   ]
}