POST Identity/GetMemberships

Returns information about a user's membership in an identity provider.

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.

Returns

Response description

Name

Description

Identities

An array of Identity Entry object values describing the ID memberships.

Example: What group does this user belong to? 

Request

POST https://tpp.venafi.example/vedsdk/Identity/GetMemberships
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ID":{
      "FullName":"\\VED\\Identity\\testuser",
      "Name":"testuser",
      "Prefix":"local",
      "PrefixedName":"local:testuser",
      "PrefixedUniversal":"local:{021442a8-21fa-4c86-806f-3864a3892ef3}",
      "Type":1,
      "Universal":"{021442a8-21fa-4c86-806f-3864a3892ef3}"
   }
}

Response

HTTP/1.1 200 OK
{
   "Identities":[
      {
         "FullName":"\\VED\\Identity\\Everyone",
         "IsGroup":true,
         "Name":"Everyone",
         "Prefix":"local",
         "PrefixedName":"local:Everyone",
         "PrefixedUniversal":"local:{d5c56a46-9da5-4832-9bba-c14b420e1b37}",
         "Type":2,
         "Universal":"{d5c56a46-9da5-4832-9bba-c14b420e1b37}"
      }
   ]
}