GET /staged_config/access/security_profiles
Get the list of staged security profiles available in the system.
Get the list of staged security profiles available in the system. The staged configuration is not active until a deploy is performed. The ADMIN or SAASADMIN capabilities are required to call this endpoint.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
tenant_id |
query |
Optional |
Number (Integer) |
text/plain |
If this parameter is provided, the endpoint will return all security profiles associated with domains that are linked to this tenant |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The staged security profile were retrieved. |
|
422 |
38340001 |
Tenant ID does not exist. |
Response Description
- id - Long - The ID of the security profile. The ID of the staged and the ID of the same deployed security profile are the same.
- name - String - The name of the security profile.
- domain_ids - Array of Integers - The list of domain ids which are assigned to the security profiles. If there is no domain assigned to the security profile, the empty list will be returned.
Response Sample
[
{
"domain_ids": [
42
],
"id": 42,
"name": "String"
}
]