Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /config/access/security_profiles

 

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

MIME Type

application/json

Table 2: 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.

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.

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.

Table 3: 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