GET /api/roles/{ResourceID}

Returns information about the security roles defined on the API platform.

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

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for information about the roles for the specified business.

Sample Request URL

https://{hostname}/api/roles/tenantbusiness.acmepaymentscorp

Sample request headers

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

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/xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml application/vnd.soa.v83+json, application/vnd.soa.v83+xml
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
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.

Response

If successful, this operation returns HTTP status code 200, with information about the roles for the specified business.

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 19:55:38 GMT

Sample response body: application/json

[
    {
        "roleName": "2FA-exempt users",
        "description": "Exempt from platform 2FA verification",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/2FA-exempt%20users"
        }
    },
    {
        "roleName": "API Administrator",
        "description": "Responsible managing the apis",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/API%20Administrator"
        }
    },
    {
        "roleName": "API Developer",
        "description": "API Developers",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/API%20Developer"
        }
    },
    {
        "roleName": "API Owner",
        "description": "Responsible for adding an api if given permission",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/API%20Owner"
        }
    },
    {
        "roleName": "API Platform Users",
        "description": "Registered Users from API Platform",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/API%20Platform%20Users"
        }
    },
    {
        "roleName": "App Team Member",
        "description": "App Team Members",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/App%20Team%20Member"
        }
    },
    {
        "roleName": "Business Administrator",
        "description": "Responsible for managing all aspects in the business",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Business%20Administrator"
        }
    },
    {
        "roleName": "Developer",
        "description": "Responsible for registering and building web services.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Developer"
        }
    },
    {
        "roleName": "Federation Member",
        "description": "Tenant Federation Members",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Federation%20Member"
        }
    },
    {
        "roleName": "Group Administrator",
        "description": "Group Administrators",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Group%20Administrator"
        }
    },
    {
        "roleName": "Group Leader",
        "description": "Group Leaders",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Group%20Leader"
        }
    },
    {
        "roleName": "Group Member",
        "description": "Group Members",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Group%20Member"
        }
    },
    {
        "roleName": "Guest",
        "description": "Responsible for allowing runtime anonymous access.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Guest"
        }
    },
    {
        "roleName": "Infrastructure Manager",
        "description": "Responsible for installing Containers, virtualizing services, and deploying services to Containers.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Infrastructure%20Manager"
        }
    },
    {
        "roleName": "LC Administrator",
        "description": "Administrators of LC content",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/LC%20Administrator"
        }
    },
    {
        "roleName": "LC User",
        "description": "General user of LC content",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/LC%20User"
        }
    },
    {
        "roleName": "Operation Manager",
        "description": "Responsible for developing security and monitoring policies and assigning them to services and organizations.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Operation%20Manager"
        }
    },
    {
        "roleName": "Organization Administrator",
        "description": "Responsible for adding, modifying and deleting organizations, managing services, policies, and Containers within an organization.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Organization%20Administrator"
        }
    },
    {
        "roleName": "Policy Administrator",
        "description": "Responsible for adding, modifying and deleting policies within an organization.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Policy%20Administrator"
        }
    },
    {
        "roleName": "Provision Manager",
        "description": "Responsible for approving contracts.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Provision%20Manager"
        }
    },
    {
        "roleName": "Security Administrator",
        "description": "Responsible for granting Users and User Groups access to Workbench within an organization.",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Security%20Administrator"
        }
    },
    {
        "roleName": "Site Administrator",
        "description": "Administrators of the tenant",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Site%20Administrator"
        }
    },
    {
        "roleName": "Tenant Business Administrator",
        "description": "Responsible for managing the apis within the Tenant",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Tenant%20Business%20Administrator"
        }
    },
    {
        "roleName": "Tenant Manager",
        "description": "Tenant Managers",
        "resourceID": "tenantbusiness.acmepaymentscorp",
        "Link": {
            "rel": "self",
            "href": "http://acmepaymentscorp.com/api/roles/tenantbusiness.acmepaymentscorp/Tenant%20Manager"
        }
    }
]

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

Response Body

Name	Type	Description
Role	Role[ ]	Contains information about a security role on the API platform. Information about all roles is returned. Information about the users assigned to the roles is not included.

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