List Roles

List of All roles

curl --request GET \
  --url https://api.squared.ai/enterprise/api/v1/roles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "1",
      "type": "roles",
      "attributes": {
        "role_name": "Admin",
        "role_desc": "An Admin can add and manage Sources, Destinations, Models, Syncs, and Workspaces.",
        "policies": {
          "permissions": {}
        },
        "updated_at": "2024-08-01T10:03:39.086Z",
        "created_at": "2024-08-01T10:03:39.021Z"
      }
    }
  ]
}

GET

enterprise

api

roles

List of All roles

curl --request GET \
  --url https://api.squared.ai/enterprise/api/v1/roles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "1",
      "type": "roles",
      "attributes": {
        "role_name": "Admin",
        "role_desc": "An Admin can add and manage Sources, Destinations, Models, Syncs, and Workspaces.",
        "policies": {
          "permissions": {}
        },
        "updated_at": "2024-08-01T10:03:39.086Z",
        "created_at": "2024-08-01T10:03:39.021Z"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

A JSON array of roles

data

object[]

Show child attributes

data.id

string

Unique identifier for the role

Example:

"1"

data.type

string

Type of the resource

Example:

"roles"

data.attributes

object

Show child attributes

data.attributes.role_name

string

Name of the role

Example:

"Admin"

data.attributes.role_desc

string

Description of the role

Example:

"An Admin can add and manage Sources, Destinations, Models, Syncs, and Workspaces."

data.attributes.policies

object

Show child attributes

data.attributes.policies.permissions

object

Show child attributes

data.attributes.policies.permissions.{key}

object

Show child attributes

data.attributes.policies.permissions.{key}.read

boolean

Example:

true

data.attributes.policies.permissions.{key}.create

boolean

Example:

true

data.attributes.policies.permissions.{key}.delete

boolean

Example:

true

data.attributes.policies.permissions.{key}.update

boolean

Example:

true

data.attributes.updated_at

string<date-time>

Timestamp of the last update

Example:

"2024-08-01T10:03:39.086Z"

data.attributes.created_at

string<date-time>

Timestamp of creation

Example:

"2024-08-01T10:03:39.021Z"

⌘I

API Overview

Connectors

Connector Definitions

Models

Syncs

Sync Runs & Records

Catalogs

Authorizations

Response