PUT Teams/RenameTeam

Renames a local Team. When you rename a team, the Policy folders that were automatically created with the old team name, will be renamed.

If the new team name is a subset of the old team name, the asset is not automatically renamed and the caller must manually adjust the asset, if needed. If an asset's DN already contains the new team name in the DN field, then it is not modified.

Requirements

Permissions: The caller must have Owner permission or have Master Admin permission.
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

Input parameters
Name	Description
Team	The PrefixedName, the word local and the Team name. For example PrefixedName:local:MyTeam.
NewTeamName	The new, unique Team name.

Returns

Response description
Name	Description
HTTP 200	For valid requests, Teams/RenameTeam returns a HTTP 200 message and the following data: Assets: The Identity Entry object that An array of the renamed Policy Folders that this team already owns and manages.. ID: The Identity Entry object that represents the renamed group. See the code example for exact return values. Message: The operation succeeded.
HTTP 400	If the response is a HTTP 400, it only contains Message and the reason for failure. Omits all other return values. Failed to rename the team: [Config result codes]

Example: Rename a local Team

Request for Example

PUT https://tpp.venafi.example/vedsdk/Teams/RenameTeam
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Team":{
      "PrefixedName":"local:Apache Team2"
   },
   "NewTeamName":"DevOpsTeam"
}

Response for Example

{
   "Assets": [
      "\\VED\\Policy\\Certificates\\DevOpsRenamed",
      "\\VED\\Policy\\Installations\\Agentless\\SAMPLE - Network Zone 1\\DevOpsRenamed",
      "\\VED\\Policy\\Installations\\Agentless\\SAMPLE - Network Zone 2\\DevOpsRenamed"
   ],
   "ID": {
      "FullName": "\\VED\\Identity\\DevOpsRenamed",
      "IsGroup": true,
      "Name": "DevOpsRenamed",
      "Prefix": "local",
      "PrefixedName": "local:DevOpsRenamed",
      "PrefixedUniversal": "local:{256314a6-2d3a-4e48-abc9-646fed745dc8}",
      "Type": 2,
      "Universal": "{256314a6-2d3a-4e48-abc9-646fed745dc8}"
   },
   "Message":"The operation succeeded."
}