DELETE Teams/(prefix)/{universal}

Deletes a team from a local identity provider. During deletion, Trust Protection Platform removes the local team and retains the identities.

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:Delete

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

(prefix)

In the request URL, specify the identity provider prefix. For example 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 team. The format of the UUID, including the absence or presence of curly braces, depends on the settings from the identity provider.

Returns

Response description

Name

Description

HTTP 400

For invalid requests, this method returns a Message and one of the following errors:

  • An unknown error occurred.

  • The team identity to be deleted is not valid or it doesn't exist.

  • The prefix or universal for the team identity is missing.

HTTP 200

For valid requests, DELETE Teams/(prefix)/{universal} returns a HTTP 200 message and the following data:

  • [Identity.Error]
  • An unknown error occurred.
  • The prefix or principal for the team identity is missing.
  • The team identity to be deleted is not valid or it doesn't exist.

Example: Remove a local team. Retain all user identities

Request for Example

DELETE https://tpp.venafi.example/vedsdk/Teams/local/{aecc642b-ded6-4928-a6aa-0143c21f41f1}
Authorization:Bearer 4MyGeneratedBearerTknz==

Response for Example

HTTP/1.1 200 OK
{
   "Message":"The operation succeeded."
}