POST Identity/GetMembers

Returns information about the members of an identity group. Members include owners. If you want group information about just one user, call POST Identity/GetMemberships.

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

ID

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

ResolveNested

When set to 1, the members of nested groups will included in the result.

Returns

Response description

Name

Description

Identities

An array of Identity Entry object values that show a group's members.

Example: List members of an Identity group

Request

POST https://tpp.venafi.example/vedsdk/Identity/GetMembers
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ID":{
      "FullName":"\\VED\\Identity\\MaintenanceGroup",
      "IsGroup":true,
      "Name":"MaintenanceGroup",
      "Prefix":"local",
      "PrefixedName":"local:MaintenanceGroup",
      "PrefixedUniversal":"local:{4e981b79-333c-4756-9434-45d4e1559ca7}",
      "Type":2,
      "Universal":"{4e981b79-333c-4756-9434-45d4e1559ca7}"
   },
   "ResolveNested":1
}

Response

There is only one group member.

HTTP/1.1 200 OK
{
   "Identities":[
      {
         "FullName":"\\VED\\Identity\\testuser3",
         "IsGroup":false,
         "Name":"testuser3",
         "Prefix":"local",
         "PrefixedName":"local:testuser3",
         "PrefixedUniversal":"local:{68c326f8-ce7c-4494-b52d-a9bb0402d6f8}",
         "Type": 1,
         "Universal":"{68c326f8-ce7c-4494-b52d-a9bb0402d6f8}",
      }
   ]
}