Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

User Management

This page outlines the operations, endpoints, parameters, and example requests and responses for the User Management.

DELETE /api/v2/groups/

Delete the user groups.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/groups/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "groups": [
    {
      "groupId": "string"
    }
  ]
}

Parameters

Name In Type Required Description
body body UserGroupBulkDelete false none

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity Multiple user groups found by the identifier. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/groups/

Create a new user group.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/groups/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "accessRoleId": "string",
  "description": "string",
  "email": "string",
  "name": "string",
  "orgId": "string"
}

Parameters

Name In Type Required Description
body body UserGroupCreate false none

Example responses

201 Response

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "maxAppCount": 0,
  "maxAppCountLimit": 0,
  "maxCustomDeployments": 0,
  "maxCustomDeploymentsLimit": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadCatalogSizeLimit": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxUploadSizeLimit": 0,
  "maxWorkers": 0,
  "membersCount": 0,
  "name": "string",
  "orgId": "string",
  "orgName": "string"
}

Responses

Status Meaning Description Schema
201 Created none UserGroupResponse
422 Unprocessable Entity Unable to process the request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/groups/{groupId}/

Delete the user group.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/groups/{groupId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
groupId path string true The identifier of the user group.

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity Multiple user groups found by the identifier. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/groups/{groupId}/

Retrieve the user group.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/groups/{groupId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
groupId path string true The identifier of the user group.

Example responses

200 Response

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "maxAppCount": 0,
  "maxAppCountLimit": 0,
  "maxCustomDeployments": 0,
  "maxCustomDeploymentsLimit": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadCatalogSizeLimit": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxUploadSizeLimit": 0,
  "maxWorkers": 0,
  "membersCount": 0,
  "name": "string",
  "orgId": "string",
  "orgName": "string"
}

Responses

Status Meaning Description Schema
200 OK none UserGroupResponse
422 Unprocessable Entity Multiple user groups found by the identifier. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/groups/{groupId}/

Update the user group.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/groups/{groupId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "accessRoleId": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "description": "string",
  "email": "string",
  "maxAppCount": 0,
  "maxCustomDeployments": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "name": "string",
  "orgId": "string"
}

Parameters

Name In Type Required Description
groupId path string true The identifier of the user group.
body body UserGroupUpdate false none

Example responses

200 Response

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "maxAppCount": 0,
  "maxAppCountLimit": 0,
  "maxCustomDeployments": 0,
  "maxCustomDeploymentsLimit": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadCatalogSizeLimit": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxUploadSizeLimit": 0,
  "maxWorkers": 0,
  "membersCount": 0,
  "name": "string",
  "orgId": "string",
  "orgName": "string"
}

Responses

Status Meaning Description Schema
200 OK none UserGroupResponse
422 Unprocessable Entity Unable to process the request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/groups/{groupId}/users/

Remove users from the group.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/groups/{groupId}/users/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "users": [
    {
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
groupId path string true The identifier of the user group.
body body ModifyUsersInGroup false none

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity The user was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/groups/{groupId}/users/

List users in the group.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/groups/{groupId}/users/?offset=0&limit=50 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
namePart query string false User groups must contain the substring.
orderBy query string false The order that the results should be retrieved in. Prefix the attribute name with a dash to sort in descending order, e.g. orderBy=-name.
groupId path string true The identifier of the user group.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "organization": "string",
      "scheduledForDeletion": true,
      "status": "active",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ListUsersInGroupResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/groups/{groupId}/users/

Add users to the group.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/groups/{groupId}/users/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "users": [
    {
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
groupId path string true The identifier of the user group.
body body ModifyUsersInGroup false none

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "organization": "string",
      "scheduledForDeletion": true,
      "status": "active",
      "userId": "string",
      "username": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none AddUsersToGroupResponse
422 Unprocessable Entity Unable to process the request, or if the user does not belong to the group's organization, or if one is already in the maximum number of groups, or if the user is not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/organizations/

List organizations available in the system.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/organizations/?limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer true At most this many results are returned.
namePart query string false Only return the organizations whose names contain the given substring.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "accountPermissions": {
        "property1": true,
        "property2": true
      },
      "agreementStatus": "NEEDED",
      "datasetRefreshJobLimit": 0,
      "datasetRefreshJobUserLimit": 0,
      "defaultUserMaxGpuWorkers": 0,
      "defaultUserMaxWorkers": 0,
      "desiredCustomModelContainerSize": 134217728,
      "enableSso": true,
      "groupsCount": 0,
      "id": "string",
      "inactiveUsersCount": 0,
      "maxCustomModelContainerSize": 134217728,
      "maxCustomModelReplicasPerDeployment": 0,
      "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
      "maxDeploymentLimit": 0,
      "maxEdaWorkers": 0,
      "maxGpuWorkers": 0,
      "maxPipelineModuleRuntimes": 0,
      "maxUploadSize": 0,
      "maxUploadSizeCatalog": 0,
      "maxWorkers": 0,
      "maximumActiveUsers": 0,
      "membersCount": 0,
      "mlopsEventStorageRetentionDays": 0,
      "name": "string",
      "ormVersion": "v1",
      "prepaidDeploymentLimit": 0,
      "restrictedSharing": true,
      "snapshotLimit": 0,
      "supportEmail": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none OrganizationListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/organizations/{organizationId}/

Retrieve the organization details.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/organizations/{organizationId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
organizationId path string true Organization ID

Example responses

200 Response

{
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "agreementStatus": "NEEDED",
  "datasetRefreshJobLimit": 0,
  "datasetRefreshJobUserLimit": 0,
  "defaultUserMaxGpuWorkers": 0,
  "defaultUserMaxWorkers": 0,
  "desiredCustomModelContainerSize": 134217728,
  "enableSso": true,
  "groupsCount": 0,
  "id": "string",
  "inactiveUsersCount": 0,
  "maxCustomModelContainerSize": 134217728,
  "maxCustomModelReplicasPerDeployment": 0,
  "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
  "maxDeploymentLimit": 0,
  "maxEdaWorkers": 0,
  "maxGpuWorkers": 0,
  "maxPipelineModuleRuntimes": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "maximumActiveUsers": 0,
  "membersCount": 0,
  "mlopsEventStorageRetentionDays": 0,
  "name": "string",
  "ormVersion": "v1",
  "prepaidDeploymentLimit": 0,
  "restrictedSharing": true,
  "snapshotLimit": 0,
  "supportEmail": "string"
}

Responses

Status Meaning Description Schema
200 OK none OrganizationRetrieve

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/organizations/{organizationId}/jobs/

List currently running jobs belonging to this organization.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/organizations/{organizationId}/jobs/?offset=0&limit=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned. If 0, all results.
organizationId path string true Organization ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "jobId": "string",
      "projectId": "string",
      "projectOwnerUserId": "string",
      "projectOwnerUsername": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none OrganizationJobListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/organizations/{organizationId}/users/

List memberships in this organization.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/organizations/{organizationId}/users/?offset=0&limit=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned. If 0, all results.
organizationId path string true Organization ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "accessRoleIds": [
        "string"
      ],
      "activated": true,
      "expirationDate": "2019-08-24T14:15:22Z",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "maxWorkers": 0,
      "orgAdmin": true,
      "organizationId": "string",
      "scheduledForDeletion": true,
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none OrganizationUserListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/organizations/{organizationId}/users/

Add user to an existing organization. A user can only be part of one organization at a time

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/organizations/{organizationId}/users/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "accessRoleId": "string",
  "accessRoleIds": [
    "string"
  ],
  "create": false,
  "firstName": "string",
  "language": "ar_001",
  "lastName": "string",
  "orgAdmin": false,
  "password": "stringst",
  "requireClickthrough": false,
  "username": "string"
}

Parameters

Name In Type Required Description
organizationId path string true Organization ID
body body OrganizationUser false none

Example responses

201 Response

{
  "userId": "string"
}

Responses

Status Meaning Description Schema
201 Created none OrganizationUserCreatedResponse
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/organizations/{organizationId}/users/{userId}/

Remove the user from the organization.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/organizations/{organizationId}/users/{userId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
organizationId path string true The organization the user is in
userId path string true The user ID

Responses

Status Meaning Description Schema
204 No Content none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/organizations/{organizationId}/users/{userId}/

Retrieve the user from this organization.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/organizations/{organizationId}/users/{userId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
organizationId path string true The organization the user is in
userId path string true The user ID

Example responses

200 Response

{
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "maxWorkers": 0,
  "orgAdmin": true,
  "organizationId": "string",
  "scheduledForDeletion": true,
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK none OrganizationUserResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/organizations/{organizationId}/users/{userId}/

Patch organization's user. Only system or the organization admin can perform this operation.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/organizations/{organizationId}/users/{userId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "accessRoleId": "string",
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "maxWorkers": 0,
  "orgAdmin": true,
  "organizationId": "string"
}

Parameters

Name In Type Required Description
organizationId path string true The organization the user is in
userId path string true The user ID
body body OrganizationUserPatch false none

Example responses

204 Response

{}

Responses

Status Meaning Description Schema
204 No Content none Empty
403 Forbidden Invalid Permissions None
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/userCleanupJobs/

Schedules a job which permanently delete the users represented by the provided users ids or organization id. Number of users to be deleted in one go is restricted by DELETED_USERS_BATCH_LIMIT system setting.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/userCleanupJobs/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "forceDeploymentDelete": false,
  "forceProjectDelete": false,
  "orgId": null,
  "orphansOwner": null,
  "userIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body UsersPermadelete false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted The users delete job status link. UsersPermadeleteJobResponse
409 Conflict Self deletion or some users are already under deletion. None
422 Unprocessable Entity Invalid data None
500 Internal Server Error Failed to schedule users perma-delete job. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userCleanupJobs/{statusId}/

Cancel permanent deletion of the selected users.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/userCleanupJobs/{statusId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
statusId path string true The ID of the status object.

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupJobs/{statusId}/

Get async status of the users perma-delete job.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupJobs/{statusId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
statusId path string true The ID of the status object.

Example responses

200 Response

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "EXPIRED",
  "statusId": "string"
}

Responses

Status Meaning Description Schema
200 OK Users perma-delete job status. UsersPermadeleteJobStatusResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/userCleanupPreviewJobs/

Schedules a job for building preview for users selected for permanent deletion. Number of users to be deleted in one go is restricted by DELETED_USERS_BATCH_LIMIT system setting.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/userCleanupPreviewJobs/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "forceDeploymentDelete": false,
  "forceProjectDelete": false,
  "orgId": null,
  "orphansOwner": null,
  "userIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body UsersPermadelete false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted The users delete preview job status link. UsersPermadeletePreviewJobResponse
409 Conflict Self deletion or some users are already under deletion. None
422 Unprocessable Entity Invalid data None
500 Internal Server Error Failed to schedule perma-delete preview building job. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userCleanupPreviewJobs/{statusId}/

Cancel scheduled users permanent delete preview building.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/userCleanupPreviewJobs/{statusId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
statusId path string true The ID of the status object.

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupPreviewJobs/{statusId}/

Get async status of the users perma-delete preview building job.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupPreviewJobs/{statusId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
statusId path string true The ID of the status object.

Example responses

200 Response

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "EXPIRED",
  "statusId": "string"
}

Responses

Status Meaning Description Schema
200 OK Perma-delete preview job status. UsersPermadeletePreviewJobStatusResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userCleanupPreviews/{reportId}/

Delete users permanent delete report.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/userCleanupPreviews/{reportId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Responses

Status Meaning Description Schema
202 Accepted Report is deleted. None
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupPreviews/{reportId}/content/

Retrieve users permanent delete extended preview.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupPreviews/{reportId}/content/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Responses

Status Meaning Description Schema
200 OK The users delete extended preview file. None
422 Unprocessable Entity Invalid data None

Response Headers

Status Header Type Format Description
200 Content-Disposition string attachment; filename="<"filename">".json JSON file with users delete extended preview.
200 Content-Type string binary application/json

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupPreviews/{reportId}/deleteParams/

Retrieve users permanent delete report parameters.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupPreviews/{reportId}/deleteParams/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Example responses

200 Response

{
  "data": {
    "forceDeploymentDelete": false,
    "forceProjectDelete": false,
    "orgId": null,
    "orphansOwner": null,
    "orphansOwnerName": "string",
    "userIds": [
      "string"
    ]
  },
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK The users delete report parameters. UsersPermadeleteDeleteReportParamsResponse
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupPreviews/{reportId}/statistics/

Retrieve users permanent delete preview statistics.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupPreviews/{reportId}/statistics/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Example responses

200 Response

{
  "data": {
    "deploymentsWillBeAssignedNewOwner": 0,
    "deploymentsWillBeDeleted": 0,
    "deploymentsWillNotBeDeleted": 0,
    "errors": 0,
    "projectsWillBeAssignedNewOwner": 0,
    "projectsWillBeDeleted": 0,
    "projectsWillNotBeDeleted": 0,
    "usersWillBeDeleted": 0,
    "usersWillNotBeDeleted": 0
  },
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK The users delete preview statistics. UsersPermadeletePreviewStatisticsResponse
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userCleanupSummaries/{reportId}/

Delete users permanent delete report.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/userCleanupSummaries/{reportId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Responses

Status Meaning Description Schema
202 Accepted Report is deleted. None
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupSummaries/{reportId}/content/

Retrieve users permanent delete extended summary.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupSummaries/{reportId}/content/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Responses

Status Meaning Description Schema
200 OK The users delete extended summary file. None
422 Unprocessable Entity Invalid data None

Response Headers

Status Header Type Format Description
200 Content-Disposition string attachment; filename="<"filename">".json JSON file with with users delete extended summary.
200 Content-Type string binary application/json

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupSummaries/{reportId}/deleteParams/

Retrieve users permanent delete report parameters.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupSummaries/{reportId}/deleteParams/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Example responses

200 Response

{
  "data": {
    "forceDeploymentDelete": false,
    "forceProjectDelete": false,
    "orgId": null,
    "orphansOwner": null,
    "orphansOwnerName": "string",
    "userIds": [
      "string"
    ]
  },
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK The users delete report parameters. UsersPermadeleteDeleteReportParamsResponse
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userCleanupSummaries/{reportId}/statistics/

Retrieve users permanent delete summary statistics.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/userCleanupSummaries/{reportId}/statistics/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
reportId path string true Report ID

Example responses

200 Response

{
  "data": {
    "deploymentsAssignedNewOwner": 0,
    "deploymentsDeleted": 0,
    "deploymentsNotDeleted": 0,
    "errors": 0,
    "projectsAssignedNewOwner": 0,
    "projectsDeleted": 0,
    "projectsNotDeleted": 0,
    "usersDeleted": 0,
    "usersNotDeleted": 0
  },
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK The users delete summary statistics. UsersPermadeleteSummaryReportStatisticsResponse
422 Unprocessable Entity Invalid data None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/users/

Create a User and add them to an organisation.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/users/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "country": "string",
  "defaultCatalogDatasetSampleSize": {
    "type": "rows",
    "value": 0
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "language": "ar_001",
  "lastName": "string",
  "maxGpuWorkers": 0,
  "maxIdleWorkers": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "organizationId": "string",
  "password": "string",
  "requireClickthroughAgreement": true,
  "userType": "AcademicUser",
  "username": "string"
}

Parameters

Name In Type Required Description
body body UserCreate false none

Example responses

200 Response

{
  "notifyStatus": {
    "inviteLink": "http://example.com",
    "sentStatus": true
  },
  "userId": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK The username and userId of the newly created user. UserCreateResponse
409 Conflict User already exists. None
422 Unprocessable Entity Password invalid/required. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/users/{userId}/limits/

User limits are those limits on an account that can be updated per-user. Rate limits that can't be modified per-user are not returned here.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/users/{userId}/limits/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
userId path string true The id of the user to retrieve usage limits for

Example responses

200 Response

{
  "accountLimits": {
    "maxUploadSize": 0,
    "maxUploadSizeCatalog": 0
  },
  "rateLimits": [
    {
      "limit": 0,
      "resource": "api",
      "usageTracked": true,
      "window": 0,
      "windowType": "seconds"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Data retrieved successfully UserLimitsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/users/{userId}/limits/

User limits are those limits on an account that can be updated per-user.Rate limits that can't be modified per-user are not returned here.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/users/{userId}/limits/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "accountLimits": {
    "maxUploadSize": 0,
    "maxUploadSizeCatalog": 0
  },
  "rateLimits": [
    {
      "limit": 0,
      "resource": "api",
      "usageTracked": true,
      "window": 0,
      "windowType": "seconds"
    }
  ]
}

Parameters

Name In Type Required Description
userId path string true The id of the user to update usage limits for
body body UserLimitsPatchBody false none

Responses

Status Meaning Description Schema
200 OK Data updated successfully None
409 Conflict The limit being updated is not available to be updated None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AccountLimits

{
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0
}

Properties

Name Type Required Restrictions Description
maxUploadSize integer false none Maximum size for file uploads (MB)
maxUploadSizeCatalog integer false none Maximum size for catalog file uploads (MB)

AddUsersToGroupResponse

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "organization": "string",
      "scheduledForDeletion": true,
      "status": "active",
      "userId": "string",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
count integer true none The number of items returned on this page.
data [UserInGroup] true none List of users in the group.

AdminSampleSize

{
  "type": "rows",
  "value": 0
}

Properties

Name Type Required Restrictions Description
type string true none Sample size can be specified only as a number of rows for now.
value integer true none Number of rows to ingest during dataset registration.

Enumerated Values

Property Value
type rows

Empty

{}

Properties

None

ListUsersInGroupResponse

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "organization": "string",
      "scheduledForDeletion": true,
      "status": "active",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none The number of items returned on this page.
data [UserInGroup] true none List of users in the group.
next string(uri)¦null true none The URL to the next page.
previous string(uri)¦null true none The URL to the previous page.
totalCount integer true none The total number of items that match the query condition.

ModifyUsersInGroup

{
  "users": [
    {
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
users [Username] true none The users to change membership for.

NotifyStatus

{
  "inviteLink": "http://example.com",
  "sentStatus": true
}

Properties

Name Type Required Restrictions Description
inviteLink string(uri) false none The link the user can follow to complete their DR account.
sentStatus boolean true none Boolean value whether an invite has been sent to the user or not.

OrganizationJob

{
  "jobId": "string",
  "projectId": "string",
  "projectOwnerUserId": "string",
  "projectOwnerUsername": "string",
  "userId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
jobId string true none The identifier of the submitted job (unique within a project)
projectId string true none The project identifier associated with this job
projectOwnerUserId string true none Identifier the user that owns the project associated with the job
projectOwnerUsername string true none The username of the user that owns the project associated with the job
userId string true none Identifies the user that submitted the job
username string true none The username of the user that submitted the job

OrganizationJobListResponse

{
  "count": 0,
  "data": [
    {
      "jobId": "string",
      "projectId": "string",
      "projectOwnerUserId": "string",
      "projectOwnerUsername": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items in current page.
data [OrganizationJob] true none List of the requested jobs
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page

OrganizationListResponse

{
  "count": 0,
  "data": [
    {
      "accountPermissions": {
        "property1": true,
        "property2": true
      },
      "agreementStatus": "NEEDED",
      "datasetRefreshJobLimit": 0,
      "datasetRefreshJobUserLimit": 0,
      "defaultUserMaxGpuWorkers": 0,
      "defaultUserMaxWorkers": 0,
      "desiredCustomModelContainerSize": 134217728,
      "enableSso": true,
      "groupsCount": 0,
      "id": "string",
      "inactiveUsersCount": 0,
      "maxCustomModelContainerSize": 134217728,
      "maxCustomModelReplicasPerDeployment": 0,
      "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
      "maxDeploymentLimit": 0,
      "maxEdaWorkers": 0,
      "maxGpuWorkers": 0,
      "maxPipelineModuleRuntimes": 0,
      "maxUploadSize": 0,
      "maxUploadSizeCatalog": 0,
      "maxWorkers": 0,
      "maximumActiveUsers": 0,
      "membersCount": 0,
      "mlopsEventStorageRetentionDays": 0,
      "name": "string",
      "ormVersion": "v1",
      "prepaidDeploymentLimit": 0,
      "restrictedSharing": true,
      "snapshotLimit": 0,
      "supportEmail": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items in current page.
data [OrganizationRetrieve] true none List of the requested organizations.
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page

OrganizationRetrieve

{
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "agreementStatus": "NEEDED",
  "datasetRefreshJobLimit": 0,
  "datasetRefreshJobUserLimit": 0,
  "defaultUserMaxGpuWorkers": 0,
  "defaultUserMaxWorkers": 0,
  "desiredCustomModelContainerSize": 134217728,
  "enableSso": true,
  "groupsCount": 0,
  "id": "string",
  "inactiveUsersCount": 0,
  "maxCustomModelContainerSize": 134217728,
  "maxCustomModelReplicasPerDeployment": 0,
  "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
  "maxDeploymentLimit": 0,
  "maxEdaWorkers": 0,
  "maxGpuWorkers": 0,
  "maxPipelineModuleRuntimes": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "maximumActiveUsers": 0,
  "membersCount": 0,
  "mlopsEventStorageRetentionDays": 0,
  "name": "string",
  "ormVersion": "v1",
  "prepaidDeploymentLimit": 0,
  "restrictedSharing": true,
  "snapshotLimit": 0,
  "supportEmail": "string"
}

Properties

Name Type Required Restrictions Description
accountPermissions object false none Account permissions available to this organization. This will only be present if the corresponding feature flag is set.
» additionalProperties boolean false none none
agreementStatus string true none The status of the organization's agreement to the terms of DataRobot.
datasetRefreshJobLimit integer¦null true none How many enabled dataset refresh jobs are allowed per-dataset for this organization.
datasetRefreshJobUserLimit integer¦null true none How many enabled dataset refresh jobs are allowed per-user for this organization.
defaultUserMaxGpuWorkers integer¦null true none Maximum number of concurrent GPU workers assigned to a newly created user of this organization.
defaultUserMaxWorkers integer¦null true none Maximum number of concurrent workers assigned to a newly created user of this organization.
desiredCustomModelContainerSize integer¦null false none The desired custom-model memory size. This will only be present if the corresponding feature flag is set.
enableSso boolean false none If the SSO is enabled for this organization. This will only be present if the corresponding feature flag is set.
groupsCount integer true none The number of user groups belonging to this organization.
id string true none The organization identifier.
inactiveUsersCount integer true none The number of inactive users for this organization.
maxCustomModelContainerSize integer¦null false none The maximum memory that might be allocated by the custom-model. This will only be present if the corresponding feature flag is set.
maxCustomModelReplicasPerDeployment integer¦null false none A fixed number of replicas that will be set for the given custom-model. This will only be present if the corresponding feature flag is set.
maxCustomModelReplicasPerDeploymentForBatchPredictions integer¦null false none The maximum custom inference model replicas per deployment for batch predictions. This will only be present if the corresponding feature flag is set.
maxDeploymentLimit integer true none The absolute limit on the number of deployments an organization is allowed to create. A value of zero means unlimited.
maxEdaWorkers integer¦null true none Maximum number of EDA workers assigned available to this organization.
maxGpuWorkers integer¦null true none Maximum number of concurrent GPU workers available to this organization.
maxPipelineModuleRuntimes integer¦null true none Maximum number of Pipeline module runtimes available to this organization.
maxUploadSize integer¦null false none Maximum size for file uploads (MB). This will only be present if the corresponding feature flag is set.
maxUploadSizeCatalog integer¦null false none Maximum size for catalog file uploads (MB). This will only be present if the corresponding feature flag is set.
maxWorkers integer¦null true none Maximum number of concurrent workers available to this organization.
maximumActiveUsers integer true none The limit for active users for this organization. A value of zero means unlimited.
membersCount integer true none The number of members in this organization.
mlopsEventStorageRetentionDays integer false none The number of days to keep MLOps events in storage. Events with older timestamps will be removed.
name string¦null true none The name of the organization.
ormVersion string true none On-demand Resource Manager (prediction service provisioning) version.
prepaidDeploymentLimit integer true none The number of deployments an organization can create under their contract. When it is reached more deployments can be made, but the user will be warned that this will result in a higher billing. A value of zero means unlimited.
restrictedSharing boolean false none Whether sharing is only allowed within the organization. This will only be present if the corresponding feature flag is set.
snapshotLimit integer¦null true none The number of snapshots allowed for a dataset for this organization.
supportEmail string¦null true none The support email of the organization.

Enumerated Values

Property Value
agreementStatus NEEDED
agreementStatus AGREED
agreementStatus N/A
ormVersion v1
ormVersion v2
ormVersion v3
ormVersion CCM

OrganizationUser

{
  "accessRoleId": "string",
  "accessRoleIds": [
    "string"
  ],
  "create": false,
  "firstName": "string",
  "language": "ar_001",
  "lastName": "string",
  "orgAdmin": false,
  "password": "stringst",
  "requireClickthrough": false,
  "username": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleId string false none [DEPRECATED - Use accessRoleIds instead] ID of the access role assigned to the user being created
accessRoleIds [string] false none List of access role ids assigned to the user being created
create boolean false none If the user should be created if not found
firstName string false none First name of the user being created
language string false none Language of the user being created
lastName string false none Last name of the user being created
orgAdmin boolean false none Is this user should be marked as an organizational admin
password string false none Password for the user being created. Should be specified if create set to true
requireClickthrough boolean false none Require the user being created to agree to a clickthrough
username string true none The username of the user to add to the organization

Enumerated Values

Property Value
language ar_001
language de_DE
language en
language es_419
language fr
language ja
language ko
language pt_BR
language test
language uk_UA

OrganizationUserCreatedResponse

{
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
userId string false none ID of the user added to the organization

OrganizationUserListResponse

{
  "count": 0,
  "data": [
    {
      "accessRoleIds": [
        "string"
      ],
      "activated": true,
      "expirationDate": "2019-08-24T14:15:22Z",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "maxWorkers": 0,
      "orgAdmin": true,
      "organizationId": "string",
      "scheduledForDeletion": true,
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items in current page.
data [OrganizationUserResponse] true none List of users in the organization.
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page

OrganizationUserPatch

{
  "accessRoleId": "string",
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "maxWorkers": 0,
  "orgAdmin": true,
  "organizationId": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleId string false none [DEPRECATED - Use accessRoleIds instead] ID of the access role assigned to the user
accessRoleIds [string] false none List of access role ids assigned to the user
activated boolean false none Whether the organization user is activated.
expirationDate string(date-time) false none User expiration date
maxWorkers integer false none User max workers
orgAdmin boolean false none Mark user as an organizational admin
organizationId string false none The organization to move the user to

OrganizationUserResponse

{
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "maxWorkers": 0,
  "orgAdmin": true,
  "organizationId": "string",
  "scheduledForDeletion": true,
  "username": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleIds [string] false none List of access role ids assigned to the user
activated boolean true none Whether the organization user is activated.
expirationDate string(date-time)¦null true none User expiration date
firstName string¦null true none First name of the user being created
id string true none The organization user identifier.
lastName string¦null true none Last name of the user being created
maxWorkers integer true none Maximum number of concurrent workers available to this user.
orgAdmin boolean true none Is this user should be marked as an organizational admin
organizationId string true none The organization identifier.
scheduledForDeletion boolean false none Whether the user is scheduled for deletion. Only set when a specific feature flag is configured.
username string true none The username of the user to add to the organization

PreviewPermadeleteStatus

{
  "message": "string",
  "reportId": "string",
  "status": "ABORTED"
}

Properties

Name Type Required Restrictions Description
message string¦null true none May contain further information about the status.
reportId string true none Report ID
status string true none The processing state of report building task.

Enumerated Values

Property Value
status ABORTED
status BLOCKED
status COMPLETED
status CREATED
status ERROR
status EXPIRED
status INITIALIZED
status PAUSED
status RUNNING

RateLimits

{
  "limit": 0,
  "resource": "api",
  "usageTracked": true,
  "window": 0,
  "windowType": "seconds"
}

Properties

Name Type Required Restrictions Description
limit integer true none The number of instances of the resource allowed during the period
resource string true none The resource being limited
usageTracked boolean false none Whether or not a persistent record of usage of this resource is recorded
window integer true none The length of the window, in 'windowType' units. For example 60 seconds, or 1 month
windowType string false none The unit of time to use for the rate limit window.

Enumerated Values

Property Value
resource api
resource custom_model_training_run
resource custom_task_predict_compute
resource custom_model_package_creation
resource custom_model_package_download
resource data_upload
resource project_create
resource prediction_upload
resource prediction_request
resource geomery_feature_plot_compute
resource feature_over_geo_plot_compute
resource feature_over_time_plot_compute
resource datetime_trend_plot_compute
resource automodels
resource predict_rows
resource catalog_item_creation
resource calendar_upload
resource blueprint_search
resource update_drift_enabled_deployment
resource submit_actuals
resource mlops_predictions_results
resource mlops_predictions_request
resource mlops_predictions_input_assignment
resource mlops_feature_stats
resource mlops_prediction_stats
resource mlops_model_package_creation
resource mlops_model_package_download
resource mlops_prediction_environment_creation
resource modmon_score_challengers
windowType seconds
windowType current_month

SummaryPermadeleteStatus

{
  "message": "string",
  "reportId": "string",
  "status": "ABORTED"
}

Properties

Name Type Required Restrictions Description
message string¦null true none May contain further information about the status.
reportId string true none Report ID
status string true none The processing state of users perma-delete task.

Enumerated Values

Property Value
status ABORTED
status BLOCKED
status COMPLETED
status CREATED
status ERROR
status EXPIRED
status INITIALIZED
status PAUSED
status RUNNING

UserCreate

{
  "country": "string",
  "defaultCatalogDatasetSampleSize": {
    "type": "rows",
    "value": 0
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "language": "ar_001",
  "lastName": "string",
  "maxGpuWorkers": 0,
  "maxIdleWorkers": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "organizationId": "string",
  "password": "string",
  "requireClickthroughAgreement": true,
  "userType": "AcademicUser",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
country string(ISO 3166-1 alpha-2 code) false none Country where the user lives.
defaultCatalogDatasetSampleSize AdminSampleSize false none Size of a sample to propose by default when enabling Fast Registration workflow.
expirationDate string(date-time) false none Datetime, RFC3339, at which the user should expire.
firstName string true none First name of the user being created.
language string false none Sets the language in the app for the user, and the language of the invite email, if the user is being invited (i.e. the password is omitted). Value must be a valid ISO-639-1 language code. Available options are: en, ja, fr, ko. System's default language will be used if omitted.
lastName string false none Last name of the user being created.
maxGpuWorkers integer false none Amount of user's available GPU workers.
maxIdleWorkers integer false none Amount of org workers that the user can utilize when idle.
maxUploadSize integer false none The upper limit for the allowed upload size for this user.
maxUploadSizeCatalog integer false none The upper limit for the allowed upload size in the AI catalog for this user.
maxWorkers integer false none Amount of user's available workers.
organizationId string false none ID of the organization to add the user to.
password string false none Creates user with this password, if blank sends username invite.
requireClickthroughAgreement boolean false none Boolean to require the user to agree to a clickthrough.
userType string true none External name for UserType such as AcademicUser, BasicUser, ProUser.
username string true none Email address of new user.

Enumerated Values

Property Value
language ar_001
language de_DE
language en
language es_419
language fr
language ja
language ko
language pt_BR
language test
language uk_UA
userType AcademicUser
userType BasicUser
userType ProUser
userType PayAsYouGoUser
userType TrialUser
userType Covid19TrialUser

UserCreateResponse

{
  "notifyStatus": {
    "inviteLink": "http://example.com",
    "sentStatus": true
  },
  "userId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
notifyStatus NotifyStatus false none User notification values.
userId string true none The ID of the user.
username string true none The username of the user.

UserGroupBulkDelete

{
  "groups": [
    {
      "groupId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
groups [UserGroupRetrieve] true none The groups to remove.

UserGroupCreate

{
  "accessRoleId": "string",
  "description": "string",
  "email": "string",
  "name": "string",
  "orgId": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleId string false none The identifier of the access role assigned to the group.
description string false none The description of this user group.
email string false none The email that can be used to contact this user group.
name string true none The name of the new user group. Must be unique.
orgId string false none The organization identifier of this user group.

UserGroupResponse

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "maxAppCount": 0,
  "maxAppCountLimit": 0,
  "maxCustomDeployments": 0,
  "maxCustomDeploymentsLimit": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadCatalogSizeLimit": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxUploadSizeLimit": 0,
  "maxWorkers": 0,
  "membersCount": 0,
  "name": "string",
  "orgId": "string",
  "orgName": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleId string¦null true none The identifier of the access role assigned to the group.
accessRoleName string¦null true none The name of the access role assigned to the group.
accountPermissions object true none Account permissions of this user group. Each key is a permission name.
» additionalProperties boolean false none none
createdBy string¦null true none The identifier of the user who created this user group.
description string¦null true none The description of this user group.
email string¦null true none The email of this user group.
id string true none The identifier of the user group.
maxAppCount integer¦null true none The maximum allowed applications count for users of this group.
maxAppCountLimit integer¦null true none The upper limit for the maximum allowed applications count. The limit is defined if the group is part of an organization, and the attribute is set on the organization level.
maxCustomDeployments integer¦null true none The number of maximum custom deployments available for users of this group.
maxCustomDeploymentsLimit integer¦null true none The upper limit for the number of maximum custom deployments. The limit is defined if the group is part of an organization, and the attribute is set on the organization level.
maxEdaWorkers integer¦null true none The upper limit for a number of EDA workers to be run for users of this user group.
maxRam integer¦null true none The upper limit for amount of RAM available to users of this user group.
maxUploadCatalogSizeLimit integer¦null true none The upper limit for the maximum upload size in the AI catalog. The limit is defined if the group is part of an organization, and the attribute is set on the organization level.
maxUploadSize integer¦null true none The maximum allowed upload size for users of this group.
maxUploadSizeCatalog integer¦null true none The maximum allowed upload size in the AI catalog for users in this group.
maxUploadSizeLimit integer¦null true none The upper limit for the maximum allowed upload size. The limit is defined if the group is part of an organization, and the attribute is set on the organization level.
maxWorkers integer¦null true none The upper limit for a number of workers to be run for users of this user group.
membersCount integer true none The number of members in this user group.
name string true none The name of the user group.
orgId string¦null true none The identifier of the organization the user group belongs to.
orgName string¦null true none The name of the organization this user group belongs to.

UserGroupRetrieve

{
  "groupId": "string"
}

Properties

Name Type Required Restrictions Description
groupId string true none The identifier of the user group.

UserGroupUpdate

{
  "accessRoleId": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "description": "string",
  "email": "string",
  "maxAppCount": 0,
  "maxCustomDeployments": 0,
  "maxEdaWorkers": 0,
  "maxRam": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxWorkers": 0,
  "name": "string",
  "orgId": "string"
}

Properties

Name Type Required Restrictions Description
accessRoleId string¦null false none The identifier of the access role to assign to the group.
accountPermissions object false none Account permissions to set for this user group. Each key is a permission name.
» additionalProperties boolean false none none
description string false none The description of this user group.
email string false none The email of this user group.
maxAppCount integer¦null false none The upper limit for the allowed applications count for the user group.
maxCustomDeployments integer¦null false none Maximum allowed value for maxCustomDeployment for the user group.
maxEdaWorkers integer false none The upper limit for a number of EDA workers to be run for users of this user group.
maxRam integer false none The upper limit for amount of RAM available to users of this user group.
maxUploadSize integer¦null false none The upper limit for the allowed upload size for the user group.
maxUploadSizeCatalog integer¦null false none The upper limit for the allowed upload size in the AI catalog for this user group.
maxWorkers integer false none The upper limit for a number of workers to be run for users of this user group.
name string false none The new name for the user group.
orgId string false none The id of the organization to assign the user group to.

UserInGroup

{
  "firstName": "string",
  "lastName": "string",
  "organization": "string",
  "scheduledForDeletion": true,
  "status": "active",
  "userId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
firstName string¦null true none The first name of the user.
lastName string¦null true none The last name of the user.
organization string¦null true none The name of the organization the user is part of.
scheduledForDeletion boolean false none If the user is scheduled for deletion. Will be returned when an appropriate FF is enabled.
status string¦null true none The status of the user, active if the has been activated, inactive otherwise.
userId string¦null true none The identifier of the user.
username string true none The name of the user.

Enumerated Values

Property Value
status active
status inactive

UserLimitsPatchBody

{
  "accountLimits": {
    "maxUploadSize": 0,
    "maxUploadSizeCatalog": 0
  },
  "rateLimits": [
    {
      "limit": 0,
      "resource": "api",
      "usageTracked": true,
      "window": 0,
      "windowType": "seconds"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accountLimits AccountLimits false none The account limits (e.g. Max Dataset size) for the user
rateLimits [RateLimits] false none The rate limits for the user that are available to be updated

UserLimitsResponse

{
  "accountLimits": {
    "maxUploadSize": 0,
    "maxUploadSizeCatalog": 0
  },
  "rateLimits": [
    {
      "limit": 0,
      "resource": "api",
      "usageTracked": true,
      "window": 0,
      "windowType": "seconds"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accountLimits AccountLimits true none The account limits (e.g. Max Dataset size) for the user
rateLimits [RateLimits] true none The rate limits for the user that are available to be updated

Username

{
  "username": "string"
}

Properties

Name Type Required Restrictions Description
username string true none The name of the user.

UsersPermadelete

{
  "forceDeploymentDelete": false,
  "forceProjectDelete": false,
  "orgId": null,
  "orphansOwner": null,
  "userIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
forceDeploymentDelete boolean true none If true, any deployment this user group has a role on, including those shared outside the users, will be deleted.
forceProjectDelete boolean true none If true, any project this user group has a role on, including those shared outside the users, will be deleted.
orgId string¦null false none Organization which's users to be permanently deleted.
orphansOwner string¦null false none User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
userIds [string] false none Users to be permanently deleted.

UsersPermadeleteDeleteReportParamsResponse

{
  "data": {
    "forceDeploymentDelete": false,
    "forceProjectDelete": false,
    "orgId": null,
    "orphansOwner": null,
    "orphansOwnerName": "string",
    "userIds": [
      "string"
    ]
  },
  "message": "string"
}

Properties

Name Type Required Restrictions Description
data UsersPermadeleteResponse true none The users cleanup delete parameters.
message string¦null true none May contain further details.

UsersPermadeleteJobResponse

{
  "message": "string"
}

Properties

Name Type Required Restrictions Description
message string¦null true none Information about the users perma-deletion job submission.

UsersPermadeleteJobStatusResponse

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "EXPIRED",
  "statusId": "string"
}

Properties

Name Type Required Restrictions Description
created string(date-time) true none The time the status record was created.
data SummaryPermadeleteStatus true none Report id and associated status.
message string¦null true none May contain further information about the status.
status string true none The processing state of the job.
statusId string true none The ID of the status object.

Enumerated Values

Property Value
status EXPIRED
status ABORTED
status RUNNING
status COMPLETED
status INITIALIZED
status ERROR

UsersPermadeletePreviewJobResponse

{
  "message": "string"
}

Properties

Name Type Required Restrictions Description
message string¦null true none Information about the users perma-deletion preview job submission.

UsersPermadeletePreviewJobStatusResponse

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "EXPIRED",
  "statusId": "string"
}

Properties

Name Type Required Restrictions Description
created string(date-time) true none The time the status record was created.
data PreviewPermadeleteStatus true none Preview report id and associated status.
message string¦null true none May contain further information about the status.
status string true none The processing state of the job.
statusId string true none The ID of the status object.

Enumerated Values

Property Value
status EXPIRED
status ABORTED
status RUNNING
status COMPLETED
status INITIALIZED
status ERROR

UsersPermadeletePreviewStatistics

{
  "deploymentsWillBeAssignedNewOwner": 0,
  "deploymentsWillBeDeleted": 0,
  "deploymentsWillNotBeDeleted": 0,
  "errors": 0,
  "projectsWillBeAssignedNewOwner": 0,
  "projectsWillBeDeleted": 0,
  "projectsWillNotBeDeleted": 0,
  "usersWillBeDeleted": 0,
  "usersWillNotBeDeleted": 0
}

Properties

Name Type Required Restrictions Description
deploymentsWillBeAssignedNewOwner integer true none Number of deployments that will be assigned a new owner.
deploymentsWillBeDeleted integer true none Number of deployments that will be deleted.
deploymentsWillNotBeDeleted integer true none Number of deployments that will not be deleted.
errors integer true none Number of errors encountered during preview construction.
projectsWillBeAssignedNewOwner integer true none Number of projects that will be assigned a new owner.
projectsWillBeDeleted integer true none Number of projects that will be deleted.
projectsWillNotBeDeleted integer true none Number of projects that will not be deleted.
usersWillBeDeleted integer true none Number of users that will be deleted.
usersWillNotBeDeleted integer true none Number of users that will not be deleted.

UsersPermadeletePreviewStatisticsResponse

{
  "data": {
    "deploymentsWillBeAssignedNewOwner": 0,
    "deploymentsWillBeDeleted": 0,
    "deploymentsWillNotBeDeleted": 0,
    "errors": 0,
    "projectsWillBeAssignedNewOwner": 0,
    "projectsWillBeDeleted": 0,
    "projectsWillNotBeDeleted": 0,
    "usersWillBeDeleted": 0,
    "usersWillNotBeDeleted": 0
  },
  "message": "string"
}

Properties

Name Type Required Restrictions Description
data UsersPermadeletePreviewStatistics true none The users cleanup report statistics.
message string¦null true none May contain further details.

UsersPermadeleteResponse

{
  "forceDeploymentDelete": false,
  "forceProjectDelete": false,
  "orgId": null,
  "orphansOwner": null,
  "orphansOwnerName": "string",
  "userIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
forceDeploymentDelete boolean true none If true, any deployment this user group has a role on, including those shared outside the users, will be deleted.
forceProjectDelete boolean true none If true, any project this user group has a role on, including those shared outside the users, will be deleted.
orgId string¦null false none Organization which's users to be permanently deleted.
orphansOwner string¦null false none User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
orphansOwnerName string false none User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
userIds [string] false none Users to be permanently deleted.

UsersPermadeleteSummaryReportStatistics

{
  "deploymentsAssignedNewOwner": 0,
  "deploymentsDeleted": 0,
  "deploymentsNotDeleted": 0,
  "errors": 0,
  "projectsAssignedNewOwner": 0,
  "projectsDeleted": 0,
  "projectsNotDeleted": 0,
  "usersDeleted": 0,
  "usersNotDeleted": 0
}

Properties

Name Type Required Restrictions Description
deploymentsAssignedNewOwner integer true none Number of deployments that are assigned a new owner.
deploymentsDeleted integer true none Number of deployments that are deleted.
deploymentsNotDeleted integer true none Number of deployments that are not deleted.
errors integer true none Number of errors encountered during users deletion.
projectsAssignedNewOwner integer true none Number of projects that are assigned a new owner.
projectsDeleted integer true none Number of projects that are deleted.
projectsNotDeleted integer true none Number of projects that are not deleted.
usersDeleted integer true none Number of users that are deleted.
usersNotDeleted integer true none Number of users that are not deleted.

UsersPermadeleteSummaryReportStatisticsResponse

{
  "data": {
    "deploymentsAssignedNewOwner": 0,
    "deploymentsDeleted": 0,
    "deploymentsNotDeleted": 0,
    "errors": 0,
    "projectsAssignedNewOwner": 0,
    "projectsDeleted": 0,
    "projectsNotDeleted": 0,
    "usersDeleted": 0,
    "usersNotDeleted": 0
  },
  "message": "string"
}

Properties

Name Type Required Restrictions Description
data UsersPermadeleteSummaryReportStatistics true none The users cleanup summary report statistics.
message string¦null true none May contain further details.

Updated June 28, 2022
Back to top