GET /api/roles/{ResourceID}/{RoleName}

Returns information about the specified security role on the API platform and the users who are assigned to it.

Authorization Roles/Permissions: Must have permission to read the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/roles/{ResourceID}/{RoleName}

Back to top

Sample Request

The example below shows a request for the list of users who are assigned to the Group Leader role.

Request URL

https://{hostname}/api/roles/tenantbusiness.acmepaymentscorp/Group%20Leader

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

application/vnd.soa.v83+json, application/vnd.soa.v83+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
ResourceID Path string Required

The unique ID for a specific resource; for example, the ScopeID or the APIVersionID.

In this context, it is the BusinessID.

RoleName Path String Required The name of a security role defined in the API platform. Spaces must be encoded in the path parameter.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the specified role and the users assigned to that role.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Content-Type : application/json
Date: Mon, 20 Aug 2018 20:39:08 GMT

Sample response body: application/json

{
    "roleName": "Group Leader",
    "resourceID": "tenantbusiness.acmepaymentscorp",
    "users": [
        {
            "userID": "5cec4d53-bbe2-4166-916b-a47a7277f7e7.acmepaymentscorp",
            "domainName": "acmepaymentscorp-users",
            "fullName": "Jane Mead"
        },
        {
            "userID": "075a5ff6-138e-40c0-b035-24b55c896305.acmepaymentscorp",
            "domainName": "acmepaymentscorp-users",
            "fullName": "Jonathan Swift"
        },
        {
            "userID": "2a89aab4-cb99-4c43-994d-165f2426d39c.acmepaymentscorp",
            "domainName": "acmepaymentscorp-users",
            "fullName": "Philip Pirrip"
        }
    ],
    "Link": {
        "rel": "self",
        "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Group%20Leader"
    }
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

application/vnd.soa.v83+json, application/vnd.soa.v83+xml

Back to top

Response Body

Name Type Description
Role Role Contains information about a security role on the API platform, and in some cases also the users who are assigned to it.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics