Users

Manage users

Get users of the account environment

get

Return the list of the user of the account environment

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Query parameters
_pageintegerOptional

Index of the page

Example: 0
_max_per_pageintegerOptional

Number of items per page

Example: 10
Responses
200

Success

application/json
Responseall of
get
/accounts/{account_id}/account_environments/{account_environment_id}/users
GET /v1/accounts/{account_id}/account_environments/{account_environment_id}/users HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "current_item_count": 1,
  "current_page": 0,
  "total_count": 1,
  "items_per_page": 10,
  "last_page": 1,
  "items": [
    {
      "data": [
        {
          "email": "text",
          "role": "ACCOUNT_OWNER"
        }
      ]
    }
  ]
}

Update the users of the account environment

put

Update the users of the account environment. It will create automatically the users which does not exist.

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Bodyobject[]
emailstringRequired

Email of the user

rolestring · enumRequired

Role of the user

Possible values:
Responses
put
/accounts/{account_id}/account_environments/{account_environment_id}/users
PUT /v1/accounts/{account_id}/account_environments/{account_environment_id}/users HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 41

[
  {
    "email": "text",
    "role": "ACCOUNT_OWNER"
  }
]

No content

Delete the users of the account environment

delete

Delete the users of the account environment. You can delete multuple users in the same time.

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Query parameters
email[]string[]Optional

Email of the user to delete

Responses
delete
/accounts/{account_id}/account_environments/{account_environment_id}/users
DELETE /v1/accounts/{account_id}/account_environments/{account_environment_id}/users HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated

Was this helpful?