Sitecore API catalog/OrderCloud/Security profiles

Security profiles

Security profiles define the access levels and permissions granted to users and roles within the platform, ensuring that only authorized individuals can perform specific actions. These profiles are customizable, allowing organizations to tailor security settings based on the unique needs of their operations and workflows.

Operations

List security profiles

Request

Security
OAuth2(Required scopes: FullAccessSecurityProfileAdminSetSecurityProfileSecurityProfileReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ID""Name""!ID""!Name"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/securityprofiles?search=string&searchOn=ID&sortBy=ID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(SecurityProfile)
Example:
[
  {
    "ID": "",
    "Name": "",
    "Roles": [ … ],
    "CustomRoles": [ … ],
    "PasswordConfig": { … }
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}