# Team and User Management APIs ### Overview These APIs provide an interface for managing [users](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/administration/administration/users) and [teams](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/administration/administration/users/teams) in Veza. * [Get Teams](#get-teams) * [Create Team](#create-team) * [Get Team](#get-team) * [Delete Team](#delete-team) * [Update Team](#update-team) * [Create User](#create-user) * [Update User](#update-user) * [Get User](#get-user) * [Delete User](#delete-user) * [List Roles](#list-roles) ### Get Teams Retrieve a list of all teams. This endpoint allows filtering and sorting of the returned teams. {% openapi src="" path="/api/v1/teams" method="get" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Create Team Create a new team, scoped to the specified provider IDs: ```json { "name": "AWS Dev Team", "policy_type": "PROVIDER_ID_SET", "providers": [ { "id": "10fc60da-9df6-4495-ae0f-abf92e0bd715", } ], "description": "Limited to aws_dev account", "sso_alias": "AWS Dev Team" } ``` The team `policy_type` determines the scope of integrations for the team. The value can be `UNBOUND` or `PROVIDER_ID_SET`: * `PROVIDER_ID_SET`: Users can only see data and manage integrations for the listed `providers`, specified by `id`. * `UNBOUND`: Users can access all providers, similar to the root team. Users on this team will share a unique set of reports and saved queries. {% openapi src="" path="/api/v1/teams" method="post" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Get Team Fetch details of a specific team by providing the team ID. {% openapi src="" path="/api/v1/teams/{id}" method="get" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Delete Team Remove a team from the system using the team ID. {% openapi src="" path="/api/v1/teams/{id}" method="delete" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Update Team Update details of an existing team. The PUT method replaces the entire team entity, while PATCH allows for partial updates. {% openapi src="" path="/api/v1/teams/{value.id}" method="put" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} {% openapi src="" path="/api/v1/teams/{value.id}" method="patch" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Create User Create a new user with details such as name, email, and team assignments. A user object includes basic attributes and team and role assignments: ```json { "name": "Demo User", "email": "user1@veza.com", "password": "password", "team_roles": [ { "team_id": "613df06e-9a40-4331-947c-5c327b54b228", "role_id": "39b50a23-da71-4d02-8504-21038fe49a2f" } ] } ``` {% openapi src="" path="/api/v1/users" method="post" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Update User Change team roles or persona for an existing user. This endpoint supports partial updates. {% openapi src="" path="/api/v1/users/{value.id}" method="patch" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Get User Retrieve details of a specific user by user ID. You can use "self" instead of an ID to retrieve current user details. {% openapi src="" path="/api/v1/users/{id}" method="get" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### Delete User Delete a user from the system by ID. {% openapi src="" path="/api/v1/users/{id}" method="delete" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %} ### List Roles Returns a paginated list of all roles available in the Veza, including role ID, name, and the associated permissions. Use this operation to get role IDs to assign team roles for users. {% openapi src="" path="/api/v1/roles" method="get" %} [openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-d0cc152d188a7ade16cd0e6e7f7f205786a7e186%2Fopenapi.yaml?alt=media) {% endopenapi %}