Team and User Management APIs

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

Overview

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

• Get Teams

• Create Team

• Get Team

• Delete Team

• Update Team

• Create User

• Update User

• Get User

• Delete User

• List Roles

Get Teams

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

GET/api/v1/teams

Query parameters

Response

200default

OK

Body

application/json

valuesarray of Team (object)

next_page_tokenstring

has_moreboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "values": [
    {
      "id": "text",
      "name": "text",
      "providers": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "created_at": "2024-11-18T05:57:42.319Z",
      "updated_at": "2024-11-18T05:57:42.319Z",
      "description": "text",
      "sso_alias": "text"
    }
  ],
  "next_page_token": "text",
  "has_more": false
}

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.

POST/api/v1/teams

Body

application/json

namestring

policy_typeinteger (enum)

providersarray of Team_TeamProvider (object)

descriptionstring

sso_aliasstring

Response

200default

OK

Body

application/json

valueTeam (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "providers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "description": "text",
    "sso_alias": "text"
  }
}

Get Team

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

GET/api/v1/teams/{id}

Path parameters

id*string

Response

200default

OK

Body

application/json

valueTeam (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "providers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "description": "text",
    "sso_alias": "text"
  }
}

Delete Team

Remove a team from the system using the team ID.

DELETE/api/v1/teams/{id}

Path parameters

id*string

Response

200default

OK

Body

application/json

DeleteTeamResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200default

{}

Update Team

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

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

Path parameters

value.id*string

Query parameters

Body

application/json

idstring

namestring

policy_typeinteger (enum)

providersarray of Team_TeamProvider (object)

created_atstring (date-time)

updated_atstring (date-time)

descriptionstring

user_countinteger (int32)

sso_aliasstring

Response

200default

OK

Body

application/json

valueTeam (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams/{value.id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "providers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "description": "text",
    "sso_alias": "text"
  }
}

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

Path parameters

value.id*string

Query parameters

Body

application/json

idstring

namestring

policy_typeinteger (enum)

providersarray of Team_TeamProvider (object)

created_atstring (date-time)

updated_atstring (date-time)

descriptionstring

user_countinteger (int32)

sso_aliasstring

Response

200default

OK

Body

application/json

valueTeam (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/teams/{value.id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "providers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "description": "text",
    "sso_alias": "text"
  }
}

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": "[e-mail]",
  "password": "password",
  "team_roles": [
    {
      "team_id": "613df06e-9a40-4331-947c-5c327b54b228",
      "role_id": "39b50a23-da71-4d02-8504-21038fe49a2f"
    }
  ]
}

POST/api/v1/users

Body

application/json

namestring

emailstring

passwordstring

personainteger (enum)

team_rolesarray of User_TeamRole (object)

digest_settingsarray of User_Digest (object)

Response

200default

OK

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "id": "text"
}

Update User

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

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

Path parameters

value.id*string

Query parameters

Body

application/json

idstring

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)

optionsUserOptions (object)

team_rolesarray of User_TeamRole (object)

digest_settingsarray of User_Digest (object)

expires_atstring (date-time)

Response

200default

OK

Body

application/json

valueGetUserResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/users/{value.id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "email": "text",
    "enabled": false,
    "last_login_at": "2024-11-18T05:57:42.319Z",
    "last_refresh_at": "2024-11-18T05:57:42.319Z",
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "logins_lifetime": "text",
    "options": {
      "can_change_password": false,
      "has_mfa": false
    },
    "team_roles": [
      {
        "team_id": "text",
        "team_name": "text",
        "role_id": "text",
        "role_name": "text"
      }
    ],
    "digest_settings": [
      {
        "digest_id": "text",
        "digest_name": "text"
      }
    ],
    "expires_at": "2024-11-18T05:57:42.319Z"
  }
}

Get User

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

GET/api/v1/users/{id}

Path parameters

id*string

Response

200default

OK

Body

application/json

idstring

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)

optionsUserOptions (object)

team_rolesarray of User_TeamRole (object)

digest_settingsarray of User_Digest (object)

expires_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "id": "text",
  "name": "text",
  "email": "text",
  "enabled": false,
  "last_login_at": "2024-11-18T05:57:42.319Z",
  "last_refresh_at": "2024-11-18T05:57:42.319Z",
  "created_at": "2024-11-18T05:57:42.319Z",
  "updated_at": "2024-11-18T05:57:42.319Z",
  "logins_lifetime": "text",
  "options": {
    "can_change_password": false,
    "has_mfa": false
  },
  "team_roles": [
    {
      "team_id": "text",
      "team_name": "text",
      "role_id": "text",
      "role_name": "text"
    }
  ],
  "digest_settings": [
    {
      "digest_id": "text",
      "digest_name": "text"
    }
  ],
  "expires_at": "2024-11-18T05:57:42.319Z"
}

Delete User

Delete a user from the system by ID.

DELETE/api/v1/users/{id}

Path parameters

id*string

Response

200default

OK

Body

application/json

valueGetUserResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/users/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "value": {
    "id": "text",
    "name": "text",
    "email": "text",
    "enabled": false,
    "last_login_at": "2024-11-18T05:57:42.319Z",
    "last_refresh_at": "2024-11-18T05:57:42.319Z",
    "created_at": "2024-11-18T05:57:42.319Z",
    "updated_at": "2024-11-18T05:57:42.319Z",
    "logins_lifetime": "text",
    "options": {
      "can_change_password": false,
      "has_mfa": false
    },
    "team_roles": [
      {
        "team_id": "text",
        "team_name": "text",
        "role_id": "text",
        "role_name": "text"
      }
    ],
    "digest_settings": [
      {
        "digest_id": "text",
        "digest_name": "text"
      }
    ],
    "expires_at": "2024-11-18T05:57:42.319Z"
  }
}

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/roles

Query parameters

Response

200default

OK

Body

application/json

rolesarray of GetRoleResponse (object)

next_page_tokenstring

has_moreboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

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