GET /api/users/{UserID}/roles?ResourceID={ResourceID}

Returns the roles the user has in relation to a specified resource.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/roles?ResourceID={ResourceID}

Sample Request

The example below shows a request for the specified user's roles in relation to the specified group.

Sample Request URL

https://{hostname}/api/users/2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp/roles?ResourceID=group24386.acmepaymentscorp

Sample request headers

GET /api/users/2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp/roles?ResourceID=group24386.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
ResourceID	Query	string	Required	The unique ID for a specific resource; for example, the ScopeID or the APIVersionID.

Response

If successful, this operation returns HTTP status code 200, with information about the user's roles in relation to the specified resource. The information is returned in JSON format.

Sample Response

The sample response below shows that the user is a leader in the specified group.

Sample response headers

HTTP/1.1 200 OK
Date: Tue, 16 Jul 2013 16:34:22 GMT
Content-Type: application/json

Sample response body

{
  "RoleName":[
    "Leader",
    "Member"
  ]
}

Response Headers

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

Header	Description
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
UserRoles	UserRoles	Contains information about a user's roles in relation to a resource.

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.

Related Topics