Rules

Get authorization rules

Retrieves some or all authorization rules, with or without paging.

get/rules

Request

  • Base URL: http://example.com/authorization
  • URL: http://example.com/authorization/rules
  • Auth: none declared

Query parameters

startinteger

The index number for the first rule in a page. default: 0

limitinteger

The maximum number of rules to return per page.

filterstring filter-criteria

Constraints on which rules to retrieve. Here are the supported filters and criteria: <ul> <li>principal (eq, ne, startsWith, endsWith, contains)</li> <li>type (eq, ne)</li> <li>principalType (eq, ne)</li> <li>permissions (in)</li> <li>objectUri (eq, ne, startsWith, endsWith, contains)</li> <li>containerUri (eq, ne, startsWith, endsWith, contains)</li> <li>mediaType (eq, ne, startsWith, endsWith, contains)</li> <li>enabled (eq, ne)</li></ul>

sortBystring sort-criteria

Instructions for sorting the retrieved rules. You can sort by name or description in ascending or descending order.

Headers

Accept-Itemstring

If provided, returns the items in the requested format. Supported media types are:<br> <ul> <li>application/vnd.sas.authorization.rule+json;version=1</li> <li>application/vnd.sas.authorization.rule+json;version=2</li> <li>application/vnd.sas.authorization.rule+json;version=3</li> <li>application/vnd.sas.authorization.rule+json;version=4</li> <li>application/vnd.sas.authorization.rule+json;version=5</li> <li>application/vnd.sas.authorization.rule+json;version=6</li> <li>application/vnd.sas.authorization.rule+json;version=7</li> <li>application/vnd.sas.authorization.rule+json;version=8</li> <li>application/vnd.sas.authorization.rule+json;version=9</li> <li>application/vnd.sas.authorization.rule+json;version=10</li> </ul>

Response

The request succeeded.

namestring

The name of the collection.

startinteger

The zero-based index of the first item in the collection.

limitinteger

The number of items that were requested for the collection.

countinteger

If populated indicates the number of items in the collection.

acceptstring

A space-delimited list of media types from which an Accept header may be constructed.

versioninteger

The version number of the collection representation. This representation is version 2.

Changes

No recorded changes to this operation across all 1 revision of this API.