GET Teams/(prefix)/{universal}
Lists all properties of an identity group. With View permission and Read permission in the UI, you can also see team owners and members.
Requirements
- Permissions: The caller must have Create permission. However, results are limited to the identity provider that authenticated the caller.
- Token scope: Configuration:Manage
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
Name |
Description |
---|---|
(prefix) |
In the request URL, specify the word local. To get {prefix} and {universal} information, call POST Identity/Browse. |
{universal} | In the request URL, specify the Universal Unique Identifier (UUID) of the local group. The format of the UUID, including the absence or presence of curly braces, depends on the settings from the identity provider. Use the value from Identity/Browse. |
Returns
Name |
Description |
---|---|
Assets |
An array of Policy folders that this group manages. |
Description | The purpose of the identity group. |
ID |
|
Members |
An array of users and groups who are members of the group.
|
Message |
If the response is a HTTP 400, it only contains Message and the reason for failure. Omits all other return values.
|
Owners |
An array of Identity group owners. |
Products |
An array of Venafi product names. |
Example: List group assets
Request for Example
GET https://tpp.venafi.example/vedsdk/Teams/local/{aecc642b-ded6-4928-a6aa-0143c21f41f1} Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example
HTTP/1.1 200 OK { "Assets":[ "\\VED\\Policy\\20.1 Standard Workflow Testing" ], "Description":"Apache DevOps Group", "ID":{ "FullName":"\\VED\\Identity\\Apache Team", "IsGroup":true, "Name":"Apache Team", "Prefix":"local", "PrefixedName":"local:Apache Team", "PrefixedUniversal":"local:{7cfd6da3-8b53-40d0-8922-2eb21507bfbb}", "Type":2, "Universal":"{7cfd6da3-8b53-40d0-8922-2eb21507bfbb}" }, "Members":[ { "FullName":"\\VED\\Identity\\Master1", "Name":"Master1", "Prefix":"local", "PrefixedName":"local:Master1", "PrefixedUniversal":"local:{dacb0fad-8014-4b7d-960c-da579e221f5b}", "Type":1, "Universal":"{dacb0fad-8014-4b7d-960c-da579e221f5b}" } ], "Owners":[ ], "Products":[ "Code Signing", "SSH" ] }