API
Start typing to search…

Onboard a tenant

post
https://{hostname}/etp-config/v3/configs//onboard-tenant

Onboards a new Tenant.

Path Params
integer
required

A unique identifier for the configuration.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
groupIds
array of integers
length ≥ 0

The group IDs with access to the tenant.

groupIds
boolean

Hides the setup wizard.

boolean

Whether to inherit the client configuration from the parent.

boolean

Whether to inherit the error page from the parent.

boolean

Whether to inherit the network configuration from the parent.

string
required
length ≥ 1

Unique name for the tenant.

integer
≥ 1

The policy template used for the tenant.

users
array of objects
required
length ≥ 1

The assigned tenant users.

users*
boolean

Whether the user has only the viewer role.

string
required
length ≥ 1

The user identifier.

string
required
length ≥ 1

The username of the tenant user.

viewerUsers
array of objects
length ≥ 0

The tenant viewer users.

viewerUsers
Responses

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json
Updated about 1 month ago