BlueConic

BlueConic Roles API

A role contains a collection of data privacy and feature access permissions that you can assign to a user. Every BlueConic user is assigned to at least one role. A user can only access the features their role grants to them. [Read more](https://support.blueconic.com/hc/en-us/articles/202607121-BlueConic-Roles?utm_source=BlueConic_User)

Documentation GitHub OpenAPI

Operations 2

GET /roles Get all roles #

GET /roles/{role} Get one role #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/blueconic-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: BlueConic REST API v2 Roles API
  description: Welcome to the BlueConic REST API v2.
  termsOfService: https://www.blueconic.com/blueconic-terms-and-conditions
  contact:
    name: Contact us
    url: https://support.blueconic.com/hc/en-us/requests/new
  license:
    name: BlueConic
    url: https://github.com/blueconic/openapi/blob/main/LICENSE.MD
  version: '100.0'
servers:
- url: https://{blueconicHostname}/rest/v2
  description: The BlueConic server
  variables:
    blueconicHostname:
      description: BlueConic server hostname, e.g. 'tenant.blueconic.net'
      default: tenantname
tags:
- name: Roles
  description: A role contains a collection of data privacy and feature access permissions that you can assign to a user. Every BlueConic user is assigned to at least one role. A user can only access the features their role grants to them. Read more
paths:
  /roles:
    get:
      tags:
      - Roles
      summary: Get all roles
      description: Retrieves all roles.
      operationId: getAllRoles
      parameters:
      - name: count
        in: query
        description: Specifies the number of results to return.
        schema:
          type: integer
          format: int64
          default: 20
          example: 10
      - name: startIndex
        in: query
        description: Specifies the index of the first item to include in the result.
        schema:
          type: integer
          format: int64
          default: 0
          example: 0
      responses:
        '200':
          description: Returns the roles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/roles'
              examples:
                Response body:
                  description: Response body
                  value: "{\n  \"itemsPerPage\" : 10,\n  \"roles\" : [ {\n    \"creationDate\" : \"2024-01-24T14:06:19.100Z\",\n    \"creator\" : {\n      \"fullName\" : \"BlueConic\",\n      \"userName\" : \"BlueConic\"\n    },\n    \"description\" : \"description here\",\n    \"id\" : \"35718e9a-f8d3-4d2d-8501-a020c563cc25\",\n    \"lastModifiedDate\" : \"2024-01-24T14:06:19.100Z\",\n    \"lastModifiedUser\" : {\n      \"fullName\" : \"BlueConic\",\n      \"userName\" : \"BlueConic\"\n    },\n    \"name\" : \"Application Manager\",\n    \"permissions\" : [ \"MANAGE_PROPERTIES\", \"READ_PROFILES\", \"MANAGE_PROFILES\", \"MANAGE_LISTENERS\", \"MANAGE_TRACKERS\", \"MANAGE_SEGMENTS\", \"MANAGE_PROFILE_MERGE_RULES\", \"MANAGE_PROFILE_COMPOSITION_RULES\", \"MANAGE_DIALOGUES\", \"CREATE_POSITIONS\", \"MANAGE_INSIGHTS\", \"MANAGE_EMAIL_NOTIFICATIONS\", \"MANAGE_LIFECYCLES\", \"USE_SIMULATOR\", \"MANAGE_CHANNELS\", \"MANAGE_PLUGINS\", \"MANAGE_CONNECTIONS\", \"MANAGE_API_V1_ACCESS_KEYS\", \"MANAGE_USERS\", \"MANAGE_ROLES\", \"MANAGE_PRIVACY_SETTINGS\", \"MANAGE_GENERAL_SETTINGS\", \"PERSONAL\", \"MANAGE_TEMPLATES\", \"MANAGE_NOTEBOOKS\", \"USE_NOTEBOOK_EDITOR\", \"APPLY_BULK_OPERATIONS\", \"MANAGE_OBJECTIVES\", \"MANAGE_TIMELINE_EVENT_TYPES\", \"READ_GROUPS\", \"MANAGE_GROUPS\", \"MANAGE_PII_VALUES\", \"READ_AUDIT_EVENTS\", \"READ_EXACT_PROFILE_STATISTICS\", \"MANAGE_APPLICATIONS\", \"AUTHORIZE_APPLICATIONS\", \"MANAGE_SINGLE_SIGN_ON_SETTINGS\", \"MANAGE_IP_BASED_ACCESS_SETTINGS\", \"MANAGE_SUPPORT_ACCESS_SETTINGS\", \"MANAGE_TIMELINE_EVENT_ROLLUPS\", \"READ_INACTIVITY_SETTINGS\", \"MANAGE_INACTIVITY_SETTINGS\", \"READ_SECURITY_SETTINGS\", \"MANAGE_SECURITY_SETTINGS\" ],\n    \"tags\" : [ \"a tag here\" ]\n  } ],\n  \"startIndex\" : 0,\n  \"totalPages\" : 14,\n  \"totalResults\" : 14\n}"
        '401':
          description: Authentication failed (unauthorized).
        '403':
          description: Authorization failed (incorrect permissions).
        '503':
          description: The server is too busy to handle the request.
      security:
      - oauth2:
        - read:roles
  /roles/{role}:
    get:
      tags:
      - Roles
      summary: Get one role
      description: Retrieves a single role.
      operationId: getOneRole
      parameters:
      - name: role
        in: path
        description: The id of the role to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the role.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleBean'
              examples:
                Response body:
                  description: Response body
                  value: "{\n  \"creationDate\" : \"2024-03-27T12:14:02.651Z\",\n  \"creator\" : {\n    \"fullName\" : \"admin@blueconic.com\",\n    \"userName\" : \"admin@blueconic.com\"\n  },\n  \"description\" : \"Role description here\",\n  \"id\" : \"0d8a5b63-a2c8-4cbd-b5de-415c1743d67c\",\n  \"lastModifiedDate\" : \"2024-03-27T12:26:31.300Z\",\n  \"lastModifiedUser\" : {\n    \"fullName\" : \"admin@blueconic.com\",\n    \"userName\" : \"admin@blueconic.com\"\n  },\n  \"name\" : \"Marketeers\",\n  \"permissions\" : [ \"MANAGE_USERS\", \"READ_EXACT_PROFILE_STATISTICS\", \"MANAGE_APPLICATIONS\", \"AUTHORIZE_APPLICATIONS\" ],\n  \"tags\" : [ \"a tag here\" ]\n}\n"
        '401':
          description: Authentication failed (unauthorized).
        '403':
          description: Authorization failed (incorrect permissions).
        '404':
          description: The role doesn't exist.
        '503':
          description: The server is too busy to handle the request.
      security:
      - oauth2:
        - read:roles
components:
  schemas:
    restrictions:
      type: object
      description: Plugin restrictions for the role. Single plugins list; only access 'deny' is supported.
      properties:
        plugins:
          type: array
          description: List of plugin restriction items (access deny only).
          items:
            $ref: '#/components/schemas/pluginRestrictionItem'
    RoleBean:
      type: object
      properties:
        creationDate:
          type: string
          format: date-time
          description: The creation date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
          readOnly: true
        creator:
          $ref: '#/components/schemas/UserBean'
        description:
          type: string
          description: The description.
        id:
          type: string
          description: The object ID.
        lastModifiedDate:
          type: string
          format: date-time
          description: The last modified date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
          readOnly: true
        lastModifiedUser:
          $ref: '#/components/schemas/UserBean'
        name:
          type: string
          description: The object name.
        permissions:
          type: array
          items:
            type: string
            enum:
            - MANAGE_PROPERTIES
            - READ_PROFILES
            - MANAGE_PROFILES
            - MANAGE_LISTENERS
            - MANAGE_TRACKERS
            - MANAGE_SEGMENTS
            - MANAGE_PROFILE_MERGE_RULES
            - MANAGE_PROFILE_COMPOSITION_RULES
            - MANAGE_DIALOGUES
            - CREATE_POSITIONS
            - MANAGE_INSIGHTS
            - MANAGE_EMAIL_NOTIFICATIONS
            - MANAGE_LIFECYCLES
            - USE_SIMULATOR
            - MANAGE_CHANNELS
            - MANAGE_PLUGINS
            - MANAGE_CONNECTIONS
            - MANAGE_API_V1_ACCESS_KEYS
            - EDIT_AI_AGENT
            - MANAGE_USERS
            - MANAGE_ROLES
            - MANAGE_PRIVACY_SETTINGS
            - MANAGE_GENERAL_SETTINGS
            - MANAGE_TEMPLATES
            - MANAGE_NOTEBOOKS
            - USE_NOTEBOOK_EDITOR
            - APPLY_BULK_OPERATIONS
            - MANAGE_OBJECTIVES
            - MANAGE_TIMELINE_EVENT_TYPES
            - MANAGE_AI_CANVAS
            - MANAGE_GROWTH_PLAYS
            - READ_GROUPS
            - MANAGE_GROUPS
            - MANAGE_PII_VALUES
            - READ_AUDIT_EVENTS
            - READ_EXACT_PROFILE_STATISTICS
            - MANAGE_APPLICATIONS
            - AUTHORIZE_APPLICATIONS
            - MANAGE_SINGLE_SIGN_ON_SETTINGS
            - MANAGE_IP_BASED_ACCESS_SETTINGS
            - MANAGE_SUPPORT_ACCESS_SETTINGS
            - MANAGE_TIMELINE_EVENT_ROLLUPS
            - READ_INACTIVITY_SETTINGS
            - MANAGE_INACTIVITY_SETTINGS
            - READ_SECURITY_SETTINGS
            - MANAGE_SECURITY_SETTINGS
            - MANAGE_MODELS
            - TRANSFER_CONFIGURATION
        restrictions:
          $ref: '#/components/schemas/restrictions'
        tags:
          type: array
          description: The tags (i.e. labels).
          example: Address
          items:
            type: string
            description: The tags (i.e. labels).
            example: Address
      required:
      - permissions
    roles:
      type: object
      properties:
        itemsPerPage:
          type: integer
          format: int32
          description: Number of results per page.
          readOnly: true
        roles:
          type: array
          items:
            $ref: '#/components/schemas/RoleBean'
        startIndex:
          type: integer
          format: int32
          description: The start index.
          readOnly: true
        totalPages:
          type: integer
          format: int32
          description: The total number of pages.
          readOnly: true
        totalResults:
          type: integer
          format: int32
          description: The total number of results.
          readOnly: true
    UserBean:
      type: object
      description: BlueConic user.
      properties:
        fullName:
          type: string
          description: The full name of the user.
        userName:
          type: string
          description: The username.
      readOnly: true
    pluginRestrictionItem:
      type: object
      description: 'Single plugin restriction: pluginId, access (only ''deny'' supported), operations (e.g. create, edit).'
      properties:
        access:
          type: string
          description: Access type; only 'deny' is supported.
          enum:
          - deny
        operations:
          type: array
          description: Operations to restrict (e.g. create, edit).
          items:
            type: string
            description: Operations to restrict (e.g. create, edit).
            enum:
            - create
            - edit
        pluginId:
          type: string
          description: Plugin identifier.
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'Authenticates a registered OAuth 2.0 client. The Authorization code flow and Client credentials flow are supported. Make sure to select the correct flow based on which flow the registered client supports. The client id and client secret can be found in BlueConic by opening the registered client under *Settings* > *Access management* > *Applications*.<br/>**NOTE:** When using the Authorization code flow, the redirect URL of the registered client in BlueConic must be set to `https://rest.apidoc.blueconic.com/oauth-receiver.html` and ''Send Proof Key for Code Exchange'' must be enabled.<br/><br/>To use a Bearer token for authentication, follow these steps: <br/>1. Acquire the token through authentication.<br/>2. Include the token in the request''s Authorization header as Bearer \<token\>.<br/>3. Send the request to access protected resources.<br/>4. Handle token expiration by refreshing or obtaining a new token.'
      flows:
        clientCredentials:
          tokenUrl: /rest/v2/oauth/token
        authorizationCode:
          authorizationUrl: /rest/v2/oauth/authorize
          tokenUrl: /rest/v2/oauth/token
          refreshUrl: /rest/v2/oauth/token