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

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

200

OK

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

Lists all groups in your organization

get

Required Permissions

• Global: View Users And Groups

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

200

OK

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

Retrieve a list of permission sets. Users must be able to manage permission sets.

get

Required Permissions

• Global: Manage Permission Sets

Query parameters

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

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

Get all user and group permissions granted to a dataset.

get

Required Permissions

• Dataset: Share

Path parameters

datasetIdstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/dataset/{datasetId}/shares HTTP/1.1
Host: 
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

Required Permissions

• Dataset: Share

Path parameters

datasetIdstringRequired

The ID of the dataset

Body

application/jsontext/jsonapplication/*+json

all ofOptional

A request to modify the permission assignments for a resource.

Responses

200

OK

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /api/dataset/{datasetId}/shares/bulk HTTP/1.1
Host: 
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"
    }
  ]
}