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/{id}

Get a deployed security profile by ID.

Get a deployed security profile by ID. 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/{id} Resource Details

MIME Type

application/json

Table 2: GET /config/access/security_profiles/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

The ID of the security profile to get.

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/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The deployed security profile was retrieved.

404

38331001

The security profile ID does not exist.

Response Description

A single deployed security profile.

  • 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