DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Role

Role

List & Create

HTTP REQUEST: GET

Lists the roles for the organization

GET/api/1.0/org/{orgId}/roles
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "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"
      }
    ]
  }
}

HTTP REQUEST: POST

Create a new Role

POST/api/1.0/org/{orgId}/roles
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
Request Body
{
  "title": "Design Center Role",
  "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"
    }
  ]
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "b77d6615-fee8-4457-697f-bb2e1f79fc51",
    "title": "Design Center Role",
    "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"
      }
    ]
  }
}

Update & Delete

HTTP REQUEST: POST

Update an existing Role

POST/api/1.0/org/{orgId}/roles/{roleId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
roleIdstringThe role ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
Request Body
{
  "title": "Design Center Role NEW NAME",
  "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"
    }
  ]
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "b77d6615-fee8-4457-697f-bb2e1f79fc51",
    "title": "Design Center Role NEW NAME",
    "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"
      }
    ]
  }
}

HTTP REQUEST: DELETE

Delete an existing Role

DELETE/api/1.0/org/{orgId}/roles/{roleId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
roleIdstringThe role ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "b77d6615-fee8-4457-697f-bb2e1f79fc51",
    "title": "Design Center Role NEW NAME",
    "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"
      }
    ]
  }
}