List All Roles V2

List roles

GET/v2/roles

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the List All Roles V2 action (under management).
Fill in the fields below, then reference the result from later steps as {{listAllRolesV2.response.data}}.

Fields

baseUrlstring

The API host this action calls. Override to point at a different environment.

Default "https://yourbaseurl.talon.one/"

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 200 with an object. Read it in later steps with {{listAllRolesV2.response.data.<field>}}.

totalResultSizeinteger (int64)

dataarray<object>

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

modifiedstring (date-time)required

The time this entity was last modified.

accountIdinteger (int64)required

The ID of the account that owns this entity.

namestring

Name of the role.

descriptionstring

Description of the role.

permissionsobject2 fields

membersarray<integer (int64)>

A list of user IDs the role is assigned to.

isReadonlyboolean

Identifies if the role is read-only. For read-only roles, you can only assign or unassign users. You cannot edit any other properties, such as the name, description, or permissions. The 'isReadonly' property cannot be set for new or existing roles. It is reserved for predefined roles, such as the Talon.One support role.

Default false

json

{
  "totalResultSize": 1,
  "data": [
    {
      "accountId": 3886,
      "isReadonly": false,
      "created": {},
      "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": {
          "campaignAccessGroups": {
            "5": "Campaign access group manager permission set"
          },
          "loyaltyPrograms": {
            "10": "Loyalty program manager permission set"
          },
          "account": "account",
          "applications": {
            "1": {
              "application": "Application permission set"
            },
            "3": {
              "campaign": "Campaign manager permission set"
            },
            "4": {
              "draftCampaign": "Campaign read-only permission set"
            },
            "5": {
              "tools": "Tools permission set"
            }
          }
        }
      },
      "members": [
        10,
        12
      ],
      "name": "Campaign and campaign access group manager",
      "modified": {},
      "description": "Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.",
      "id": 6
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?