PUT Teams/AddTeamMembers
Assigns one or more identities to a team. The identity is a person or group with access to Trust Protection Platform.
The team resides in one local identity provider and details are available in the UI. However, members, which are Trust Protection Platform users or groups, originate from a local, AD, or LDAP provider.
TIP The way to add people or groups to a team, depends on your company's process:
- If you want to add team members without user intervention, call PUT Teams/AddTeamMembers.
- To manage self-service user requests to join a team, call POST Flow/Tickets/Approve or POST Flow/Tickets/Reject instead.
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 |
---|---|
Members |
An array of user or group identities that are not currently in the Team. At least one valid identity is required. To get this information, call POST Identity/Browse or use the UI. The syntax varies based on the identity provider. For more information, see Identity Information:
|
Team |
(Optional)A PrefixedName for the new local team. For example, PrefixedName:local:Apache Team3. |
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/AddTeamMembers returns a HTTP 200 message and the following data.
Name |
Description |
---|---|
InvalidMembers |
Appears only if an individual or group member is missing from the identity tree.
|
Members |
An array of every group 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 group and list all members
Request
PUT https://tpp.venafi.example/vedsdk/Teams/AddTeamMembers Authorization:Bearer 4MyGeneratedBearerTknz== { "Team":{ "PrefixedName":"local:Apache Team" }, "Members":[ { "PrefixedName":"local:EVGroup", "PrefixedUniversal":"local:{20b74d54-3d48-4214-9e55-cff650989939}" }, { "PrefixedName":"AD+venqa:bob.tomato" }, { "PrefixedUniversal":"AD+venqa:11111a11111a11111a11111a1111111a" } ], "ShowMembers":true }
Response
HTTP/1.1 200 OK { "InvalidMembers":[ { "Prefix":"AD+venqa", "PrefixedName":"AD+venqa:", "PrefixedUniversal":"AD+venqa:11111a11111a11111a11111a1111111a", "Universal":"11111a11111a11111a11111a1111111a" } ], "Members":[ { "FullName":"\\VED\\Identity\\TeamAlphaGroup", "IsGroup":true, "Name":"TeamAlphaGroup", "Prefix":"local", "PrefixedName":"local:TeamAlphaGroup", "PrefixedUniversal":"local:{aecc642b-ded6-4928-a6aa-0143c21f41f1}", "Type":2, "Universal":"{aecc642b-ded6-4928-a6aa-0143c21f41f1}" }, { "FullName":"\\VED\\Identity\\testuser2", "Name":"testuser2", "Prefix":"local", "PrefixedName":"local:testuser2", "PrefixedUniversal":"local:{add227bf-fbec-47c5-9eec-1a62393275f4}", "Type":1, "Universal":"{add227bf-fbec-47c5-9eec-1a62393275f4}" }, { "FullName":"\\VED\\Identity\\testuser", "Name":"testuser", "Prefix":"local", "PrefixedName":"local:testuser", "PrefixedUniversal":"local:{27622835-1292-40b3-ac16-55845635c658}", "Type":1, "Universal":"{27622835-1292-40b3-ac16-55845635c658}" }, { "Prefix":"local", "PrefixedName":"local:Writer", "PrefixedUniversal":":{4d45e4df-74a1-4ba6-8fe1-24f313036f55}", "Universal":"{4d45e4df-74a1-4ba6-8fe1-24f313036f55}" }, { "FullName":"CN=Bob Tomato,OU=TPP Integration Test Users,DC=venqa,DC=venafi,DC=com", "Name":"bob.tomato", "Prefix":"AD+venqa", "PrefixedName":"AD+venqa:bob.tomato", "PrefixedUniversal":"AD+venqa:c0737e55e7bcc340aa426bfe2e639362", "Universal":"c0737e55e7bcc340aa426bfe2e639362" } ] }