List Roles

GET 
/org/:orgId/roles

Lists the roles for the organization

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "roles": [
      {
        "id": "designcenter_user",
        "title": "Design Center User",
        "permissions": [
          {
            "id": "dc_user",
            "name": "designcenter.user"
          },
          {
            "id": "queries_view",
            "name": "queries.view"
          },
          {
            "id": "aggregates_view",
            "name": "aggregates.view"
          },
          {
            "id": "object_create",
            "name": "object.create"
          }
        ]
      },
      {
        "id": "org_admin",
        "title": "Organization Admin",
        "permissions": [
          {
            "id": "dc_user",
            "name": "designcenter.user"
          },
          {
            "id": "org_admin",
            "name": "organization.admin"
          },
          {
            "id": "queries_view",
            "name": "queries.view"
          },
          {
            "id": "aggregates_view",
            "name": "aggregates.view"
          },
          {
            "id": "queries_manage",
            "name": "queries.manage"
          },
          {
            "id": "aggregates_manage",
            "name": "aggregates.manage"
          },
          {
            "id": "runtime.user.settings",
            "name": "runtime.user.settings"
          },
          {
            "id": "datawarehouses_admin",
            "name": "datawarehouses.admin"
          },
          {
            "id": "object_create",
            "name": "object.create"
          },
          {
            "id": "view_support_logs",
            "name": "view.support.logs"
          }
        ]
      },
      {
        "id": "query_user",
        "title": "Runtime Query User",
        "permissions": null
      },
      {
        "id": "65696585-8623-432b-541f-780be31468d8",
        "title": "food",
        "permissions": null
      }
    ],
    "permissions": [
      {
        "id": "dc_user",
        "name": "designcenter.user"
      },
      {
        "id": "org_admin",
        "name": "organization.admin"
      },
      {
        "id": "runtime.user.settings",
        "name": "runtime.user.settings"
      },
      {
        "id": "aggregates_view",
        "name": "aggregates.view"
      },
      {
        "id": "aggregates_manage",
        "name": "aggregates.manage"
      },
      {
        "id": "queries_view",
        "name": "queries.view"
      },
      {
        "id": "queries_manage",
        "name": "queries.manage"
      },
      {
        "id": "datawarehouses_admin",
        "name": "datawarehouses.admin"
      },
      {
        "id": "object_create",
        "name": "object.create"
      },
      {
        "id": "view_support_logs",
        "name": "view.support.logs"
      },
      {
        "id": "impersonate_user",
        "name": "impersonate.user"
      }
    ]
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "roles": [
      {
        "id": "designcenter_user",
        "title": "Design Center User",
        "permissions": [
          {
            "id": "dc_user",
            "name": "designcenter.user"
          },
          {
            "id": "queries_view",
            "name": "queries.view"
          },
          {
            "id": "aggregates_view",
            "name": "aggregates.view"
          },
          {
            "id": "object_create",
            "name": "object.create"
          }
        ]
      },
      {
        "id": "org_admin",
        "title": "Organization Admin",
        "permissions": [
          {
            "id": "dc_user",
            "name": "designcenter.user"
          },
          {
            "id": "org_admin",
            "name": "organization.admin"
          },
          {
            "id": "queries_view",
            "name": "queries.view"
          },
          {
            "id": "aggregates_view",
            "name": "aggregates.view"
          },
          {
            "id": "queries_manage",
            "name": "queries.manage"
          },
          {
            "id": "aggregates_manage",
            "name": "aggregates.manage"
          },
          {
            "id": "runtime.user.settings",
            "name": "runtime.user.settings"
          },
          {
            "id": "datawarehouses_admin",
            "name": "datawarehouses.admin"
          },
          {
            "id": "object_create",
            "name": "object.create"
          },
          {
            "id": "view_support_logs",
            "name": "view.support.logs"
          }
        ]
      },
      {
        "id": "query_user",
        "title": "Runtime Query User",
        "permissions": null
      },
      {
        "id": "65696585-8623-432b-541f-780be31468d8",
        "title": "food",
        "permissions": null
      }
    ],
    "permissions": [
      {
        "id": "dc_user",
        "name": "designcenter.user"
      },
      {
        "id": "org_admin",
        "name": "organization.admin"
      },
      {
        "id": "runtime.user.settings",
        "name": "runtime.user.settings"
      },
      {
        "id": "aggregates_view",
        "name": "aggregates.view"
      },
      {
        "id": "aggregates_manage",
        "name": "aggregates.manage"
      },
      {
        "id": "queries_view",
        "name": "queries.view"
      },
      {
        "id": "queries_manage",
        "name": "queries.manage"
      },
      {
        "id": "datawarehouses_admin",
        "name": "datawarehouses.admin"
      },
      {
        "id": "object_create",
        "name": "object.create"
      },
      {
        "id": "view_support_logs",
        "name": "view.support.logs"
      },
      {
        "id": "impersonate_user",
        "name": "impersonate.user"
      }
    ]
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...