Dependency-Track unofficial
POST/v1/team

Update a team's fields

Updates fields on an existing team, including its name, users, permissions, API keys, and identity-provider mappings. Send the team values you want to update; name must be 1 to 255 characters and contain no control characters. The authenticated user must have ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_UPDATE permission.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

10 body fields

Optional team fields to update, including team identity, users, permissions, API keys, and group mappings.

apiKeysarray<object>optional
API keys associated with the team, including key values, public IDs, comments, and timestamps.
ldapUsersarray<object>optional
LDAP users associated with the team, including their distinguished names, email addresses, usernames, permissions, and team memberships.
managedUsersarray<object>optional
Managed users associated with the team, including usernames, profile details, password settings, permissions, suspension state, and team memberships.
mappedLdapGroupsarray<object>optional
LDAP groups mapped to the team, each with a distinguished name and UUID.
mappedOidcGroupsarray<object>optional
OIDC groups mapped to the team, each with a UUID and group details.
namestringrequired
The team name. Must be 1 to 255 characters and contain no control characters.
oidcUsersarray<object>optional
OIDC users associated with the team, including usernames, email addresses, subject identifiers, permissions, and team memberships.
permissionsarray<object>optional
Permissions associated with the team, including the permission name and its user associations.
serviceAccountsarray<object>optional
Service accounts associated with the team, including usernames, email addresses, permissions, suspension state, and team memberships.
uuidstringrequired
The team's UUID.

3 status codes
200Returns the updated team object, including its UUID, name, API keys, users, permissions, service accounts, and mapped identity-provider groups.
apiKeysarray<object>optional
ldapUsersarray<object>optional
managedUsersarray<object>optional
mappedLdapGroupsarray<object>optional
mappedOidcGroupsarray<object>optional
namestringrequired
oidcUsersarray<object>optional
permissionsarray<object>optional
serviceAccountsarray<object>optional
uuidstringrequired
401Returned when the request is unauthorized.
404Returned when the team to update could not be found.

Error handling

A 401 is returned when the request is unauthorized; the authenticated user must have ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_UPDATE permission. A 404 is returned when the team identified by uuid cannot be found. If supplied, name must be 1 to 255 characters and contain no control characters.