Skip to main content
POST
Create an environment request

Authorizations

Authorization
string
header
required

Azure AD app-only access token. Obtain it from GET /v1/oauthToken and send it as the Authorization: Bearer {token} header.

Body

application/json

Supply either a SecurityTemplateID or both AdminUsersStr and GenericUsersStr.

Title
string
required

Request title (max 50 characters).

EnvironmentType
enum<string>
required

Environment type.

Available options:
Sandbox,
UAT,
Production,
NA
SecurityTemplateID
string<uuid>

ID of an existing security template.

AdminUsersStr
string

Semicolon-separated admin users. Required if no security template is supplied.

GenericUsersStr
string

Semicolon-separated generic users. Required if no security template is supplied.

PrintViewersStr
string

Semicolon-separated print viewers.

AppInstanceID
string
Rationale
string

Reason for the request (max 50 characters).

Response

Successful operation

RequestID
string<uuid>
Title
string
EnvironmentType
enum<string>

Environment type.

Available options:
Sandbox,
UAT,
Production,
NA
RequestStatus
enum<string>

Request lifecycle status.

Available options:
AwaitingApproval,
Accepted,
NotAccepted,
Processing,
Completed,
Failed
SecurityTemplateID
string<uuid> | null
AdminUsersStr
string
GenericUsersStr
string
PrintViewersStr
string
SiteCollection
string
Site
string
NewSiteUrl
string
URL
string
AppInstanceID
string
Rationale
string
Author
string
Created
string<date-time> | null