TAtalon
Roles

List roles

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List the roles defined in the deployment.

The roles returned depend on the role of the user calling this endpoint:

  • If the user has an admin role, all roles defined in the deployment are returned.
  • If the user does not have an admin role, only the roles currently assigned to this user are returned.

If your identity provider provisions roles through SCIM, any admin roles it defines are not included in this list.

To view the details of a specific role, use the Get role endpoint.

get/v2/roles

Request

Response

OK

totalResultSizeinteger required

The total number of roles returned.

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "modified": "2021-09-12T10:12:42Z",
      "accountId": 3886,
      "name": "Campaign and campaign access group manager",
      "description": "Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.",
      "permissions": {
        "permissionSets": [
          {
            "name": "Application permission set",
            "logicalOperations": [
              "getApplicationOperations",
              "editApplicationOperations"
            ]
          },
          {
            "name": "Campaign manager permission set",
            "logicalOperations": [
              "getCampaignOperations",
              "createCampaignOperations",
              "updateCampaignOperations"
            ]
          },
          {
            "name": "Campaign read-only permission set",
            "logicalOperations": [
              "getCampaignOperations"
            ]
          },
          {
            "name": "Loyalty program read-only permission set",
            "logicalOperations": [
              "getLoyaltyProgramOperations"
            ]
          },
          {
            "name": "Campaign access group manager permission set",
            "logicalOperations": [
              "getCampaignAccessGroupOperations",
              "updateCampaignAccessGroupOperations",
              "deleteCampaignAccessGroupOperations"
            ]
          }
        ],
        "roles": {
          "applications": {
            "1": {
              "application": "Application permission set"
            },
            "3": {
              "campaign": "Campaign manager permission set"
            },
            "4": {
              "draftCampaign": "Campaign read-only permission set"
            },
            "5": {
              "tools": "Tools permission set"
            }
          },
          "loyaltyPrograms": {
            "10": "Loyalty program manager permission set"
          },
          "campaignAccessGroups": {
            "5": "Campaign access group manager permission set"
          },
          "account": "Account administration permission set"
        },
        "thresholds": [
          {
            "loyaltyProgramId": 8,
            "loyaltyPointsLimit": 100
          }
        ]
      },
      "members": [
        10,
        12
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.