Team and User Management APIs

Operations for listing, creating, deleting, and updating users and teams.

PreviousNotification Templates API NextTeam API Keys

Last updated 7 months ago

Was this helpful?

Overview

These APIs provide an interface for managing users and teams in Veza.

Get Teams

Retrieve a list of all teams. This endpoint allows filtering and sorting of the returned teams.

Create Team

Create a new team, scoped to the specified provider IDs:

{
  "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.

Get Team

Fetch details of a specific team by providing the team ID.

Delete Team

Remove a team from the system using the team ID.

Update Team

Update details of an existing team. The PUT method replaces the entire team entity, while PATCH allows for partial updates.

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:

{
  "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"
    }
  ]
}

Update User

Change team roles or persona for an existing user. This endpoint supports partial updates.

Get User

Retrieve details of a specific user by user ID. You can use "self" instead of an ID to retrieve current user details.

Delete User

Delete a user from the system by ID.

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.

get

/api/v1/teams

Authorizations

Query parameters

filterstring

order_bystring

page_sizeinteger · int32

page_tokenstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/teams' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{
  "next_page_token": "text",
  "has_more": true,
  "values": [
    {
      "id": "text",
      "name": "text",
      "policy_type": 1,
      "created_at": "2025-02-20T18:59:04.450Z",
      "updated_at": "2025-02-20T18:59:04.450Z",
      "description": "text",
      "user_count": 1,
      "sso_alias": "text",
      "providers": [
        {
          "id": "text",
          "name": "text",
          "type": 1
        }
      ]
    }
  ]
}

OK

post

/api/v1/teams

Authorizations

Body

namestring

policy_typeinteger · enum

descriptionstring

sso_aliasstring

providersobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/teams' \
  --header 'Authorization: Bearer Bearer <API key>' \
  --header 'Content-Type: application/json' \
  --data '{"providers":[{}]}'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "policy_type": 1,
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "description": "text",
    "user_count": 1,
    "sso_alias": "text",
    "providers": [
      {
        "id": "text",
        "name": "text",
        "type": 1
      }
    ]
  }
}

OK

get

/api/v1/teams/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/teams/{id}' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "policy_type": 1,
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "description": "text",
    "user_count": 1,
    "sso_alias": "text",
    "providers": [
      {
        "id": "text",
        "name": "text",
        "type": 1
      }
    ]
  }
}

OK

delete

/api/v1/teams/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/teams/{id}' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{}

OK

put

/api/v1/teams/{value.id}

Authorizations

Path parameters

value.idstringrequired

Query parameters

update_maskstring · field-mask

Body

idstring

namestring

policy_typeinteger · enum

created_atstring · date-time

updated_atstring · date-time

descriptionstring

user_countinteger · int32

sso_aliasstring

providersobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/teams/{value.id}' \
  --header 'Authorization: Bearer Bearer <API key>' \
  --header 'Content-Type: application/json' \
  --data '{"providers":[{"id":"text","name":"text","type":1}]}'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "policy_type": 1,
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "description": "text",
    "user_count": 1,
    "sso_alias": "text",
    "providers": [
      {
        "id": "text",
        "name": "text",
        "type": 1
      }
    ]
  }
}

OK

patch

/api/v1/teams/{value.id}

Authorizations

Path parameters

value.idstringrequired

Query parameters

update_maskstring · field-mask

Body

idstring

namestring

policy_typeinteger · enum

created_atstring · date-time

updated_atstring · date-time

descriptionstring

user_countinteger · int32

sso_aliasstring

providersobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/v1/teams/{value.id}' \
  --header 'Authorization: Bearer Bearer <API key>' \
  --header 'Content-Type: application/json' \
  --data '{"providers":[{"id":"text","name":"text","type":1}]}'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "policy_type": 1,
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "description": "text",
    "user_count": 1,
    "sso_alias": "text",
    "providers": [
      {
        "id": "text",
        "name": "text",
        "type": 1
      }
    ]
  }
}

OK

post

/api/v1/users

Authorizations

Body

namestring

emailstring

passwordstring

personainteger · enum

given_namestring

family_namestring

display_namestring

team_rolesobject[]

digest_settingsobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/users' \
  --header 'Authorization: Bearer Bearer <API key>' \
  --header 'Content-Type: application/json' \
  --data '{"team_roles":[{}],"digest_settings":[{}]}'

200

default

{
  "id": "text"
}

OK

patch

/api/v1/users/{value.id}

Authorizations

Path parameters

value.idstringrequired

Query parameters

update_maskstring · field-mask

Body

idstring

namestring

display_namestring

given_namestring

family_namestring

emailstring

enabledboolean

last_login_atstring · date-time

last_refresh_atstring · date-time

created_atstring · date-time

updated_atstring · date-time

logins_lifetimestring

auth_provider_typeinteger · enum

personainteger · enum

optionsobject

UserOptions define the options available on the user. These options do not account for permissions of the caller or callee.

Actors:

User (reflexive) declares that the user may perform this action on themselves.
System declares that Veza may perform this action, i.e. the action is supported by the current system and IDP configuration.

expires_atstring · date-time

team_rolesobject[]

digest_settingsobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/v1/users/{value.id}' \
  --header 'Authorization: Bearer Bearer <API key>' \
  --header 'Content-Type: application/json' \
  --data '{"options":{},"team_roles":[{}],"digest_settings":[{}]}'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "display_name": "text",
    "given_name": "text",
    "family_name": "text",
    "email": "text",
    "enabled": true,
    "last_login_at": "2025-02-20T18:59:04.450Z",
    "last_refresh_at": "2025-02-20T18:59:04.450Z",
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "logins_lifetime": "text",
    "auth_provider_type": 1,
    "persona": 1,
    "options": {},
    "expires_at": "2025-02-20T18:59:04.450Z",
    "team_roles": [
      {}
    ],
    "digest_settings": [
      {}
    ]
  }
}

OK

get

/api/v1/users/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/users/{id}' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{
  "id": "text",
  "name": "text",
  "display_name": "text",
  "given_name": "text",
  "family_name": "text",
  "email": "text",
  "enabled": true,
  "last_login_at": "2025-02-20T18:59:04.450Z",
  "last_refresh_at": "2025-02-20T18:59:04.450Z",
  "created_at": "2025-02-20T18:59:04.450Z",
  "updated_at": "2025-02-20T18:59:04.450Z",
  "logins_lifetime": "text",
  "auth_provider_type": 1,
  "persona": 1,
  "options": {},
  "expires_at": "2025-02-20T18:59:04.450Z",
  "team_roles": [
    {}
  ],
  "digest_settings": [
    {}
  ]
}

OK

delete

/api/v1/users/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/users/{id}' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{
  "value": {
    "id": "text",
    "name": "text",
    "display_name": "text",
    "given_name": "text",
    "family_name": "text",
    "email": "text",
    "enabled": true,
    "last_login_at": "2025-02-20T18:59:04.450Z",
    "last_refresh_at": "2025-02-20T18:59:04.450Z",
    "created_at": "2025-02-20T18:59:04.450Z",
    "updated_at": "2025-02-20T18:59:04.450Z",
    "logins_lifetime": "text",
    "auth_provider_type": 1,
    "persona": 1,
    "options": {},
    "expires_at": "2025-02-20T18:59:04.450Z",
    "team_roles": [
      {}
    ],
    "digest_settings": [
      {}
    ]
  }
}

OK

get

/api/v1/roles

Authorizations

Query parameters

page_sizeinteger · int32

page_tokenstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/roles' \
  --header 'Authorization: Bearer Bearer <API key>'

200

default

{
  "next_page_token": "text",
  "has_more": true,
  "roles": [
    {
      "id": "text",
      "name": "text",
      "is_admin": true,
      "permissions": [
        "text"
      ]
    }
  ]
}

OK