GET /config/access/security_profiles

date_range 24-May-22

arrow_backward

arrow_forward

SUMMARY Get the list of deployed security profiles available in the system.

Get the list of deployed security profiles available in the system. You must have System Administrator or Security Administrator permissions to call this endpoint if you are trying to retrieve a security profile that is not assigned to you. You can retrieve your own security profile without having System Administrator or Security Administrator permissions.

Table 1: GET /config/access/security_profiles resource details:
GET /config/access/security_profiles resource details
MIME Type
application/json

Table 2: GET /config/access/security_profiles request parameter details:
GET /config/access/security_profiles request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
tenant_id	query	Optional	Number (Integer)	text/plain	If this parameter is provided, the endpoint returns all security profiles associated with domains that are linked to this tenant.
current_security_profile	query	Optional	Boolean	text/plain	If this parameter is provided, the endpoint will return just the security profile associated with the current user. This filter only changes the behaviour of the endpoint for users with the System Administrator or Security Administrator permissions.
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.

Table 3: GET /config/access/security_profiles response codes:
GET /config/access/security_profiles response codes
HTTP Response Code	Unique Code	Description
200		A list of the deployed security profiles.
422	38330001	Tenant ID does not exist.

Response Description

A list of the deployed security profiles.

id - Long - The ID of the security profile. The ID of the staged and the ID of the same deployed user 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 profile. If there is no domain ID assigned to the security profile, an empty list is returned. Access Domains using /config/domain_management/domains API.

Response Sample

content_copy zoom_out_map
[
    {
        "domain_ids": [
            42
        ],
        "id": 42,
        "name": "String"
    }
]

arrow_backward PREVIOUS POST /config/access/authorized_services/{id}

NEXT arrow_forward GET /config/access/security_profiles/{id}

REST API Version 17.0 References

ON THIS PAGE

GET /config/access/security_profiles

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry