PUT Teams/AddTeamOwners
Assigns owner identities to a team. The team itself resides in one local provider. However, members, which are Trust Protection Platform users or groups, can originate from a local, AD, or LDAP provider.
Requirements
- Permissions: The caller must have Owner permission or have Master Admin permission. However, results are limited to the identity provider that authenticated the caller. For example, if a LDAP caller tries to change information about an AD identity, the API call returns an empty JSON result.
- 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 |
---|---|
Team |
(Optional) A PrefixedName for the new local team. For example, PrefixedName:local:Apache Team3. |
Owners |
(Optional) An array of current team owners. The syntax varies based on the identity provider. For more information, see Identity Information:
|
ShowMembers |
(Optional) List or omit owners and members from the response:
|
Returns
The response depends on the ShowMembers setting. If ShowMembers is false, this method returns only a HTTP 200 message. Otherwise, Teams/AddTeamOwners returns a HTTP 200 message and the following data.
Name |
Description |
---|---|
InvalidMembers |
Appears only if an individual or team member is missing from the identity tree.
|
Members |
An array of every team member.
|
Message |
If the response is a HTTP 400, it only contains Message and the reason for failure. Omits all other return values.
|
Example: Add users to a local identity team. List all members
Request
PUT https://tpp.venafi.example/vedsdk/Teams/AddTeamOwners Authorization:Bearer 4MyGeneratedBearerTknz== { "Team":{ "PrefixedName":"local:Apache Team" }, "Owners":[ { "PrefixedName":"local:Master1", "PrefixedUniversal":"local:{dacb0fad-8014-4b7d-960c-da579e221f5b}" } ], "ShowMembers":true }
Response
HTTP/1.1 200 OK { "Members":[ { "FullName":"\\VED\\Identity\\EVG", "IsGroup":true, "Name":"Everyone", "Prefix":"local", "PrefixedName":"local:EVG", "PrefixedUniversal":"local:{20b74d54-3d48-4214-9e55-cff650989939}", "Type":2, "Universal":"{20b74d54-3d48-4214-9e55-cff650989939}" }, { "Prefix":"Writer", "PrefixedName":"local:Writer", "PrefixedUniversal":":{0dc60f5c-314b-44ad-a611-bd42656665d2}", "Universal":"{0dc60f5c-314b-44ad-a611-bd42656665d2}" } ], "Owners":[ { "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}" } ] }