Environments

List Environments

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/

List Linked Accounts

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
namestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/linked_accounts

List Available Accounts

get

Returns all available accounts. Note that accounts which are already associated with the supplied environment as well as those which are automated via OU associations are excluded.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
namestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/accounts

Update Environment For Accounts

post

Update the environment associated with a list of accounts. Note that any account in the list that is already associated with an environment that is managed by the system via OU mapping will be ignored.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · enumRequiredPossible values:
sourcestring · enumRequiredPossible values:
account_liststring[]Required
Responses
200

Successful Response

application/json
post
/api/environments/accounts

List Linked Organizational Units

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
namestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/linked_organizational_units

List Organizational Units

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
namestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/organizational_units

Update Environment For Ous

post

Update the environment associated with a list of OUs.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · enumRequiredPossible values:
sourcestring · enumRequiredPossible values:
organizational_unit_liststring[]Required
Responses
200

Successful Response

application/json
post
/api/environments/organizational_units

Unassign Ou

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
ou_idstringRequired
namestring · enumRequiredPossible values:
sourcestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
delete
/api/environments/organizational_unit/unassign

List Tags For Environment

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sourcestring · enumRequiredPossible values:
namestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
get
/api/environments/tags

Assign Tag To Environment

post

Associate a tag key/value pair with an environment

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · enumRequiredPossible values:
sourcestring · enumRequiredPossible values:
tag_keystringRequired
tag_valuestringRequired
case_sensitivebooleanRequired
allow_resource_overridebooleanRequired
Responses
200

Successful Response

application/json
post
/api/environments/tag

Unassign Tag

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
tag_keystringRequired
tag_valuestringRequired
sourcestring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
delete
/api/environments/tag/unassign

List Active Task Status

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
task_typeany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/environments/task_statuses/active

Last updated

Was this helpful?