Access management

Use the API to retrieve information about users and groups, and to manage access to datasets.

Lists all users in your organization

get

Required Permissions

• Global: View Users And Groups

Responses

200

OK

text/plainapplication/jsontext/json

idstringRequired

userNamestring · nullableRequired

firstNamestring · nullableOptional

lastNamestring · nullableOptional

organizationIdstring · nullableOptional

teamNamestring · nullableOptional

get

/api/Users

HTTPcURLJavaScriptPython

GET /api/Users HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "organizationId": "text",
    "photoMetadata": {
      "name": "text",
      "url": "text",
      "fileType": "text",
      "content": "Ynl0ZXM=",
      "isManualUpload": true
    },
    "accountMetadata": {
      "createdAt": {},
      "lastActivityDate": {}
    },
    "teamName": "text"
  }
]

Lists all groups in your organization

get

Required Permissions

• Global: View Users And Groups

Responses

200

OK

text/plainapplication/jsontext/json

idstringRequired

userNamestring · nullableRequired

contextall ofRequiredPossible values:

string · enumOptionalPossible values:

get

/api/Groups

HTTPcURLJavaScriptPython

GET /api/Groups HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "userName": "text",
    "context": "None"
  }
]

Retrieve a list of permission sets.

get

Users that have the global permission Manage permission sets get the full details, including the available operations.

Required Permissions

• Global (At least 1 of the following): Manage Permission Sets, Manage User Global Permissions

Query parameters

Responses

200

OK

text/plainapplication/jsontext/json

idstringRequired

The ID of the permission set.

typeall ofOptional

The type discriminator for Permission Sets which determines the kinds of operations available to that Permission Set.Possible values:

Possible values:

string · enumOptional

The type discriminator for Permission Sets which determines the kinds of operations available to that Permission Set.Possible values:

Possible values:

namestringRequired

The name of the permission set.

isBuiltInbooleanOptional

Whether the permission set is built-in.

isDefaultbooleanOptional

Whether the permission set is the default permission set for its type.

isDisabledbooleanOptional

Whether the permission set is disabled.

lastModifiedDateall ofOptional

The date when the permission set was last modified.

objectOptional

operationsinteger · int32[] · nullableOptional

The operations of the permission set. Only included for users with Manage Permission Sets permission.

createdDateall of · nullableOptional

The date when the permission set was created. Only included for users with Manage Permission Sets permission.

objectOptional

lastModifiedByUserIdstring · nullableOptional

The ID of the user who last modified the permission set. Only included for users with Manage Permission Sets permission.

400

Bad Request

text/plainapplication/jsontext/json

get

/api/permission-sets

HTTPcURLJavaScriptPython

GET /api/permission-sets HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "type": "Global",
    "name": "text",
    "isBuiltIn": true,
    "isDefault": true,
    "isDisabled": true,
    "lastModifiedDate": {},
    "operations": [
      1
    ],
    "createdDate": {},
    "lastModifiedByUserId": "text"
  }
]

Get all user and group permissions granted to a dataset.

get

Path parameters

datasetIdstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

A model that represents a user or a group that was assigned a permission set for a dataset.

idstringOptional

The ID of the share.

permissionSetIdstringOptional

The ID of the permission set that is shared.

shareableEntityTypeall ofOptional

Indicates whether the dataset was shared with a user or with a group.Possible values:

Possible values:

string · enumOptionalPossible values:

resourceIdstringOptional

The ID of the dataset that is shared.

get

/api/dataset/{datasetId}/shares

HTTPcURLJavaScriptPython

GET /api/dataset/{datasetId}/shares HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "permissionSetId": "text",
    "sharedWithUser": {
      "id": "text",
      "userName": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "sharedWithGroup": {
      "id": "text",
      "userName": "text",
      "context": "None"
    },
    "shareableEntityType": "User",
    "resourceId": "text"
  }
]

Modify the permissions assigned to a dataset.

post

Path parameters

datasetIdstringRequired

The ID of the dataset

Body

application/jsontext/jsonapplication/*+json

A request to modify the permission assignments for a dataset.

Responses

200

OK

text/plainapplication/jsontext/json

Response for modifying the permission set assignments of a dataset.

post

/api/dataset/{datasetId}/shares/bulk

HTTPcURLJavaScriptPython

POST /api/dataset/{datasetId}/shares/bulk HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "grant": [
    {
      "sharedWithUserId": "text",
      "sharedWithGroupId": "text",
      "permissionSetId": "text"
    }
  ],
  "revoke": [
    {
      "sharedWithUserId": "text",
      "sharedWithGroupId": "text",
      "permissionSetId": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "granted": [
    {
      "id": "text",
      "permissionSetId": "text",
      "sharedWithUser": {
        "id": "text",
        "userName": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "sharedWithGroup": {
        "id": "text",
        "userName": "text",
        "context": "None"
      },
      "shareableEntityType": "User",
      "resourceId": "text"
    }
  ],
  "revoked": [
    {
      "id": "text",
      "permissionSetId": "text",
      "sharedWithUser": {
        "id": "text",
        "userName": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "sharedWithGroup": {
        "id": "text",
        "userName": "text",
        "context": "None"
      },
      "shareableEntityType": "User",
      "resourceId": "text"
    }
  ]
}