DataRobot API resources > API reference documentation > DataRobot REST API > User Management

User Management¶

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

POST /api/v2/bulkUserOperations/¶

Make multiple User creation requests in bulk from a list.

Code samples¶

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/bulkUserOperations/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

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

Parameters

Name	In	Type	Required	Description
body	body	UserBulkCreate	false	none

Example responses¶

{
  "count": 0,
  "data": [
    {
      "data": {
        "message": "string",
        "notifyStatus": {
          "inviteLink": "http://example.com",
          "sentStatus": true
        },
        "userId": "string",
        "username": "string"
      },
      "requestId": "string",
      "statusCode": 100
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of responses from each User creation request.	UserBulkCreateResponse
422	Unprocessable Entity	Invalid request payload.	None

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

BearerAuth

DELETE /api/v2/groups/¶

Delete the user groups.

Code samples¶

# You can also use wget
curl -X DELETE https://app.datarobot.com/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

GET /api/v2/groups/¶

List the user groups that satisfy the query condition.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/groups/?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.
orgId	query	any	false	List user groups for the organization. If the value is `unowned`, the route will filter for groups that aren't owned by any organization.
userId	query	string	false	List user groups that the user is part of.
excludeUserMembership	query	string	false	Indicates if the search by `namePart` should exclude the groups that the user with userId is a member.
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`.

Enumerated Values¶

Parameter	Value
excludeUserMembership	[`false`, `False`, `true`, `True`]
orderBy	[`name`, `-name`, `orgName`, `-orgName`, `accessRoleName`, `-accessRoleName`]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "accessRoleId": "string",
      "accessRoleName": "string",
      "accountPermissions": {
        "property1": true,
        "property2": true
      },
      "createdBy": "string",
      "description": "string",
      "email": "string",
      "id": "string",
      "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"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	UserGroupsListResponse

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 https://app.datarobot.com/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¶

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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¶

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "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 https://app.datarobot.com/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",
  "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¶

{
  "accessRoleId": "string",
  "accessRoleName": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "createdBy": "string",
  "description": "string",
  "email": "string",
  "id": "string",
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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=-username`.
isActive	query	string	false	If specified, filters results by account activation status.
isAdmin	query	string	false	If specified, filters results to admin users (system and org) or non-admin users.
groupId	path	string	true	The identifier of the user group.

Enumerated Values¶

Parameter	Value
orderBy	[`username`, `-username`, `userGroup`, `-userGroup`, `lastName`, `-lastName`, `firstName`, `-firstName`, `status`, `-status`, `expirationDate`, `-expirationDate`]
isActive	[`false`, `False`, `true`, `True`]
isAdmin	[`false`, `False`, `true`, `True`]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "expirationDate": "string",
      "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 https://app.datarobot.com/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¶

{
  "count": 0,
  "data": [
    {
      "expirationDate": "string",
      "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 https://app.datarobot.com/api/v2/organizations/?limit=100&includeDeleted=false&includePermadeleted=false&deletedOnly=false \
  -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.
id	query	array[string]	false	Query for organizations with these ids
namePart	query	string	false	Only return the organizations whose names contain the given substring.
includeDeleted	query	boolean	true	Allows the ability to retrieve deleted organizations.
includePermadeleted	query	boolean	true	Allows the ability to retrieve deleted and permadeleted organizations.
deletedOnly	query	boolean	true	Allows the ability to retrieve only deleted and permadeleted organizations.

Example responses¶

{
  "count": 0,
  "data": [
    {
      "accountPermissions": {
        "property1": true,
        "property2": true
      },
      "agreementStatus": "NEEDED",
      "datasetRefreshJobLimit": 0,
      "datasetRefreshJobUserLimit": 0,
      "defaultUserMaxGpuWorkers": 0,
      "defaultUserMaxWorkers": 0,
      "deleted": true,
      "deletedAt": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "desiredCustomModelContainerSize": 134217728,
      "enableSso": true,
      "groupsCount": 0,
      "id": "string",
      "inactiveUsersCount": 0,
      "maxCodespaces": 0,
      "maxComputeServerlessPredictionApi": 1,
      "maxConcurrentBatchPredictionsJob": 1,
      "maxConcurrentNotebooks": 0,
      "maxCustomModelContainerSize": 134217728,
      "maxCustomModelReplicasPerDeployment": 0,
      "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
      "maxDailyBatchesPerDeployment": 1,
      "maxDeploymentLimit": 0,
      "maxEdaWorkers": 0,
      "maxEnabledNotebookSchedules": 1,
      "maxExecutionEnvironments": 0,
      "maxGpuWorkers": 0,
      "maxLlmApiCalls": 1,
      "maxNotebookMachineSize": "L",
      "maxNotebookSchedulingWorkers": 1,
      "maxPipelineModuleRuntimes": 0,
      "maxUploadSize": 0,
      "maxUploadSizeCatalog": 0,
      "maxVectorDatabases": 1,
      "maxWorkers": 0,
      "maximumActiveUsers": 0,
      "membersCount": 0,
      "mlopsEventStorageRetentionDays": 0,
      "name": "string",
      "notebooksSoftDeletionRetentionPeriod": "string",
      "ormVersion": "v1",
      "permadeleted": true,
      "permadeletedAt": "2019-08-24T14:15:22Z",
      "permadeletedBy": "string",
      "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 https://app.datarobot.com/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¶

{
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "agreementStatus": "NEEDED",
  "datasetRefreshJobLimit": 0,
  "datasetRefreshJobUserLimit": 0,
  "defaultUserMaxGpuWorkers": 0,
  "defaultUserMaxWorkers": 0,
  "deleted": true,
  "deletedAt": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "desiredCustomModelContainerSize": 134217728,
  "enableSso": true,
  "groupsCount": 0,
  "id": "string",
  "inactiveUsersCount": 0,
  "maxCodespaces": 0,
  "maxComputeServerlessPredictionApi": 1,
  "maxConcurrentBatchPredictionsJob": 1,
  "maxConcurrentNotebooks": 0,
  "maxCustomModelContainerSize": 134217728,
  "maxCustomModelReplicasPerDeployment": 0,
  "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
  "maxDailyBatchesPerDeployment": 1,
  "maxDeploymentLimit": 0,
  "maxEdaWorkers": 0,
  "maxEnabledNotebookSchedules": 1,
  "maxExecutionEnvironments": 0,
  "maxGpuWorkers": 0,
  "maxLlmApiCalls": 1,
  "maxNotebookMachineSize": "L",
  "maxNotebookSchedulingWorkers": 1,
  "maxPipelineModuleRuntimes": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxVectorDatabases": 1,
  "maxWorkers": 0,
  "maximumActiveUsers": 0,
  "membersCount": 0,
  "mlopsEventStorageRetentionDays": 0,
  "name": "string",
  "notebooksSoftDeletionRetentionPeriod": "string",
  "ormVersion": "v1",
  "permadeleted": true,
  "permadeletedAt": "2019-08-24T14:15:22Z",
  "permadeletedBy": "string",
  "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 https://app.datarobot.com/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¶

{
  "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 https://app.datarobot.com/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¶

{
  "count": 0,
  "data": [
    {
      "accessRoleIds": [
        "string"
      ],
      "activated": true,
      "expirationDate": "2019-08-24T14:15:22Z",
      "externalId": "string",
      "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.

Code samples¶

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/organizations/{organizationId}/users/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

{
  "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¶

{
  "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

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

Retrieve the user from this organization.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/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¶

{
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "externalId": "string",
  "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 https://app.datarobot.com/api/v2/organizations/{organizationId}/users/{userId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

{
  "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¶

{}

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

GET /api/v2/tenants/{tenantId}/activeUsers/¶

A route to retrieve active tenant users over a specified time period. Only system or organization admins can perform this operation.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/tenants/{tenantId}/activeUsers/?start=2019-08-24&end=2019-08-24 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
start	query	string(date)	true	The start date for the usage data.
end	query	string(date)	true	The end date for the usage date.
tenantId	path	string	true	The ID of the tenant.

Example responses¶

{
  "data": [
    {
      "fullname": "string",
      "userId": "string",
      "username": "string"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ActiveUsersResponse

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

BearerAuth

GET /api/v2/tenants/{tenantId}/usage/¶

A route to retrieve aggregated or per-user tenant resource usage over some period of time. Only system or organization admins can perform this operation.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/tenants/{tenantId}/usage/?start=2019-08-24&end=2019-08-24 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
start	query	string(date)	true	The start date for the usage data.
end	query	string(date)	true	The end date for the usage date.
userId	query	string	false	Only usage performed by this user will be retrieved.
workloadCategory	query	string	false	Workload category
tenantId	path	string	true	The ID of the tenant.

Enumerated Values¶

Parameter	Value
workloadCategory	[`all`, `All`, `ALL`, `gpuUsage`, `GpuUsage`, `GPU_USAGE`]

Example responses¶

{
  "data": [
    {
      "resourceBundleId": "string",
      "resourceBundleName": "string",
      "usageUnit": "string",
      "usageValue": 0,
      "workloadId": "string",
      "workloadName": "string"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	UsageResponse

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

BearerAuth

GET /api/v2/tenants/{tenantId}/usageExport/¶

A route to retrieve tenant resource usage over a specified time period. Only system or organization admins can perform this operation.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/tenants/{tenantId}/usageExport/?start=2019-08-24&end=2019-08-24 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
start	query	string(date)	true	The start date for the usage data.
end	query	string(date)	true	The end date for the usage date.
userId	query	string	false	Only usage performed by this user will be retrieved.
workloadCategory	query	string	false	Workload category
tenantId	path	string	true	The ID of the tenant.

Enumerated Values¶

Parameter	Value
workloadCategory	[`all`, `All`, `ALL`, `gpuUsage`, `GpuUsage`, `GPU_USAGE`]

Example responses¶

{
  "data": [
    {
      "resourceBundleId": "string",
      "resourceBundleName": "string",
      "usageUnit": "string",
      "usageValue": 0,
      "userDisplayName": "string",
      "userId": "string",
      "workloadId": "string",
      "workloadName": "string"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ExportResponse

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 https://app.datarobot.com/api/v2/userCleanupJobs/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

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

Parameters

Name	In	Type	Required	Description
body	body	UsersPermadelete	false	none

Example responses¶

{
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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¶

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "ABORTED",
  "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 https://app.datarobot.com/api/v2/userCleanupPreviewJobs/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

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

Parameters

Name	In	Type	Required	Description
body	body	UsersPermadelete	false	none

Example responses¶

{
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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¶

{
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "message": "string",
    "reportId": "string",
    "status": "ABORTED"
  },
  "message": "string",
  "status": "ABORTED",
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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 https://app.datarobot.com/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¶

{
  "data": {
    "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 https://app.datarobot.com/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¶

{
  "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 https://app.datarobot.com/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 https://app.datarobot.com/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 https://app.datarobot.com/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¶

{
  "data": {
    "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 https://app.datarobot.com/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¶

{
  "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

GET /api/v2/users/¶

Retrieve a list of existing users.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/users/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
namePart	query	string	false	When present, only return users with names that contain the given substring.
username	query	string	false	Email address of the user.
expirationDateLte	query	string(date-time)	false	Datetime, RFC3339.
activated	query	string	false	Boolean return activated or deactivated users
orderBy	query	string	false	Sort order to apply when listing users.
tenantId	query	string	false	Query users scoped to the tenant
attributionId	query	string	false	User ID in external marketing systems (SFDC)

Enumerated Values¶

Parameter	Value
activated	[`false`, `False`, `true`, `True`]
orderBy	[`registeredOn`, `-registeredOn`, `updatedAt`, `-updatedAt`]

Responses¶

Status	Meaning	Description	Schema
200	OK	Count of users returned, next/previous page URLs, and array 'data' of user objects.	None
403	Forbidden	forbidden for non-administrators.	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 organization.

Code samples¶

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/users/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

{
  "attributionId": "string",
  "company": "string",
  "country": "string",
  "defaultCatalogDatasetSampleSize": {
    "type": "rows",
    "value": 0
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "externalId": "string",
  "firstName": "string",
  "jobTitle": "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¶

{
  "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}/¶

Retrieve a single user by id.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/users/{userId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user identifier.

Responses¶

Status	Meaning	Description	Schema
200	OK	Info of requested user.	None
403	Forbidden	Forbidden for non-administrators.	None
404	Not Found	User not found.	None

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

BearerAuth

Schemas¶

ActiveUser

{
  "fullname": "string",
  "userId": "string",
  "username": "string"
}

Properties¶

Name	Type	Required	Description
fullname	string	true	The display name of the user
userId	string	true	The identifier of the user
username	string	true	The username of the user

ActiveUsersResponse

{
  "data": [
    {
      "fullname": "string",
      "userId": "string",
      "username": "string"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[ActiveUser]	true		Active users

AddUsersToGroupResponse

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

Properties¶

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

AdminSampleSize

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

Size of a sample to propose by default when enabling Fast Registration workflow.

Properties¶

Name	Type	Required	Restrictions	Description
type	string	true		Sample size can be specified only as a number of rows for now.
value	integer	true	maximum: 1000000 minimum: 0 (exclusive)	Number of rows to ingest during dataset registration.

Enumerated Values¶

Property	Value
type	`rows`

Empty

{}

Properties¶

None

ExportItem

{
  "resourceBundleId": "string",
  "resourceBundleName": "string",
  "usageUnit": "string",
  "usageValue": 0,
  "userDisplayName": "string",
  "userId": "string",
  "workloadId": "string",
  "workloadName": "string"
}

Properties¶

Name	Type	Required	Description
resourceBundleId	string	true	The identifier of the resource bundle
resourceBundleName	string	true	Human readable name of the resource bundle
usageUnit	string	true	The unit of measurement for the usage value
usageValue	number	true	Numeric measure of the usage
userDisplayName	string	true	The display name of the user
userId	string	true	The identifier of the user
workloadId	string	true	The identifier of the workload
workloadName	string	true	Human readable name of the workload

ExportResponse

{
  "data": [
    {
      "resourceBundleId": "string",
      "resourceBundleName": "string",
      "usageUnit": "string",
      "usageValue": 0,
      "userDisplayName": "string",
      "userId": "string",
      "workloadId": "string",
      "workloadName": "string"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[ExportItem]	true		Usage records

ListUsersInGroupResponse

{
  "count": 0,
  "data": [
    {
      "expirationDate": "string",
      "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		The number of items returned on this page.
data	[UserInGroup]	true	maxItems: 1000	List of users in the group.
next	string(uri)¦null	true		The URL to the next page.
previous	string(uri)¦null	true		The URL to the previous page.
totalCount	integer	true		The total number of items that match the query condition.

ModifyUsersInGroup

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

Properties¶

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

NotifyStatus

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

User notification values.

Properties¶

Name	Type	Required	Restrictions	Description
inviteLink	string(uri)	false		The link the user can follow to complete their DR account.
sentStatus	boolean	true		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	Description
jobId	string	true	The identifier of the submitted job (unique within a project)
projectId	string	true	The project identifier associated with this job
projectOwnerUserId	string	true	Identifier the user that owns the project associated with the job
projectOwnerUsername	string	true	The username of the user that owns the project associated with the job
userId	string	true	Identifies the user that submitted the job
username	string	true	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		Number of items in current page.
data	[OrganizationJob]	true	maxItems: 1000	List of the requested jobs.
next	string(uri)¦null	true		URL pointing to the next page (if null, there is no next page).
previous	string(uri)¦null	true		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,
      "deleted": true,
      "deletedAt": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "desiredCustomModelContainerSize": 134217728,
      "enableSso": true,
      "groupsCount": 0,
      "id": "string",
      "inactiveUsersCount": 0,
      "maxCodespaces": 0,
      "maxComputeServerlessPredictionApi": 1,
      "maxConcurrentBatchPredictionsJob": 1,
      "maxConcurrentNotebooks": 0,
      "maxCustomModelContainerSize": 134217728,
      "maxCustomModelReplicasPerDeployment": 0,
      "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
      "maxDailyBatchesPerDeployment": 1,
      "maxDeploymentLimit": 0,
      "maxEdaWorkers": 0,
      "maxEnabledNotebookSchedules": 1,
      "maxExecutionEnvironments": 0,
      "maxGpuWorkers": 0,
      "maxLlmApiCalls": 1,
      "maxNotebookMachineSize": "L",
      "maxNotebookSchedulingWorkers": 1,
      "maxPipelineModuleRuntimes": 0,
      "maxUploadSize": 0,
      "maxUploadSizeCatalog": 0,
      "maxVectorDatabases": 1,
      "maxWorkers": 0,
      "maximumActiveUsers": 0,
      "membersCount": 0,
      "mlopsEventStorageRetentionDays": 0,
      "name": "string",
      "notebooksSoftDeletionRetentionPeriod": "string",
      "ormVersion": "v1",
      "permadeleted": true,
      "permadeletedAt": "2019-08-24T14:15:22Z",
      "permadeletedBy": "string",
      "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		Number of items in current page.
data	[OrganizationRetrieve]	true	maxItems: 1000	List of the requested organizations.
next	string(uri)¦null	true		URL pointing to the next page (if null, there is no next page)
previous	string(uri)¦null	true		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,
  "deleted": true,
  "deletedAt": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "desiredCustomModelContainerSize": 134217728,
  "enableSso": true,
  "groupsCount": 0,
  "id": "string",
  "inactiveUsersCount": 0,
  "maxCodespaces": 0,
  "maxComputeServerlessPredictionApi": 1,
  "maxConcurrentBatchPredictionsJob": 1,
  "maxConcurrentNotebooks": 0,
  "maxCustomModelContainerSize": 134217728,
  "maxCustomModelReplicasPerDeployment": 0,
  "maxCustomModelReplicasPerDeploymentForBatchPredictions": 1,
  "maxDailyBatchesPerDeployment": 1,
  "maxDeploymentLimit": 0,
  "maxEdaWorkers": 0,
  "maxEnabledNotebookSchedules": 1,
  "maxExecutionEnvironments": 0,
  "maxGpuWorkers": 0,
  "maxLlmApiCalls": 1,
  "maxNotebookMachineSize": "L",
  "maxNotebookSchedulingWorkers": 1,
  "maxPipelineModuleRuntimes": 0,
  "maxUploadSize": 0,
  "maxUploadSizeCatalog": 0,
  "maxVectorDatabases": 1,
  "maxWorkers": 0,
  "maximumActiveUsers": 0,
  "membersCount": 0,
  "mlopsEventStorageRetentionDays": 0,
  "name": "string",
  "notebooksSoftDeletionRetentionPeriod": "string",
  "ormVersion": "v1",
  "permadeleted": true,
  "permadeletedAt": "2019-08-24T14:15:22Z",
  "permadeletedBy": "string",
  "prepaidDeploymentLimit": 0,
  "restrictedSharing": true,
  "snapshotLimit": 0,
  "supportEmail": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
accountPermissions	object	false		Account permissions available to this organization. This will only be present if the corresponding feature flag is set.
» additionalProperties	boolean	false		none
agreementStatus	string	true		The status of the organization's agreement to the terms of DataRobot.
datasetRefreshJobLimit	integer¦null	true		How many enabled dataset refresh jobs are allowed per-dataset for this organization.
datasetRefreshJobUserLimit	integer¦null	true		How many enabled dataset refresh jobs are allowed per-user for this organization.
defaultUserMaxGpuWorkers	integer¦null	true		Maximum number of concurrent GPU workers assigned to a newly created user of this organization.
defaultUserMaxWorkers	integer¦null	true		Maximum number of concurrent workers assigned to a newly created user of this organization.
deleted	boolean¦null	false		Indicates whether the organization is soft-deleted.
deletedAt	string(date-time)¦null	false		Indicates when the organization was soft-deleted.
deletedBy	string¦null	false		Indicates who has soft-deleted the organization.
desiredCustomModelContainerSize	integer¦null	false	maximum: 15032385536 minimum: 134217728	The desired custom-model memory size. This will only be present if the corresponding feature flag is set.
enableSso	boolean	false		If the SSO is enabled for this organization. This will only be present if the corresponding feature flag is set.
groupsCount	integer	true		The number of user groups belonging to this organization.
id	string	true		The organization identifier.
inactiveUsersCount	integer	true		The number of inactive users for this organization.
maxCodespaces	integer¦null	false		Maximum number of codespaces available to this organization.
maxComputeServerlessPredictionApi	integer¦null	false	minimum: 1	The number of maximum allowed compute on a serverless platform for this organization
maxConcurrentBatchPredictionsJob	integer¦null	false	maximum: 10 minimum: 1	Maximum number of concurrent batch prediction jobs to this organization
maxConcurrentNotebooks	integer¦null	false		Maximum number of concurrent notebooks available to this organization.
maxCustomModelContainerSize	integer¦null	false	maximum: 15032385536 minimum: 134217728	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	maximum: 8 minimum: 0 (exclusive)	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	maximum: 8 minimum: 1	The maximum custom inference model replicas per deployment for batch predictions. This will only be present if the corresponding feature flag is set.
maxDailyBatchesPerDeployment	integer¦null	false	minimum: 1	The maximum number of monitoring batches that can be created per day on deployments that belong to this organization.
maxDeploymentLimit	integer	true		The absolute limit on the number of deployments an organization is allowed to create. A value of zero means unlimited.
maxEdaWorkers	integer¦null	true		Maximum number of EDA workers assigned available to this organization.
maxEnabledNotebookSchedules	integer¦null	false	minimum: 1	Maximum number of enabled notebook schedules for this organization.
maxExecutionEnvironments	integer¦null	true	minimum: 0	The upper limit for the number of maximum execution environments. The limit is defined if the group is part of an organization, and the attribute is set on the organization level.
maxGpuWorkers	integer¦null	true		Maximum number of concurrent GPU workers available to this organization.
maxLlmApiCalls	integer¦null	true	minimum: 1	Maximum number of LLM calls.
maxNotebookMachineSize	string¦null	false		Maximum size of notebook machine available to this organization.
maxNotebookSchedulingWorkers	integer¦null	false	maximum: 20 minimum: 1	Maximum number of concurrently running notebooks schedules for this organization.
maxPipelineModuleRuntimes	integer¦null	true		Maximum number of Pipeline module runtimes available to this organization.
maxUploadSize	integer¦null	false		Maximum size for file uploads (MB). This will only be present if the corresponding feature flag is set.
maxUploadSizeCatalog	integer¦null	false		Maximum size for catalog file uploads (MB). This will only be present if the corresponding feature flag is set.
maxVectorDatabases	integer¦null	true	minimum: 1	Maximum number of local vector databases.
maxWorkers	integer¦null	true		Maximum number of concurrent workers available to this organization.
maximumActiveUsers	integer	true		The limit for active users for this organization. A value of zero means unlimited.
membersCount	integer	true		The number of members in this organization.
mlopsEventStorageRetentionDays	integer	false	minimum: 0	The number of days to keep MLOps events in storage. Events with older timestamps will be removed.
name	string¦null	true		The name of the organization.
notebooksSoftDeletionRetentionPeriod	string¦null	false		Retention window for soft-deleted notebooks and respective resources before NBX services hard-delete them.
ormVersion	string	true		On-demand Resource Manager (prediction service provisioning) version.
permadeleted	boolean¦null	false		Indicates whether the organization is permadeleted.
permadeletedAt	string(date-time)¦null	false		Indicates when the organization was permadeleted.
permadeletedBy	string¦null	false		Indicates who has permadeleted the organization.
prepaidDeploymentLimit	integer	true		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		Whether sharing is only allowed within the organization. This will only be present if the corresponding feature flag is set.
snapshotLimit	integer¦null	true		The number of snapshots allowed for a dataset for this organization.
supportEmail	string¦null	true		The support email of the organization.

Enumerated Values¶

Property	Value
agreementStatus	[`NEEDED`, `AGREED`, `N/A`]
maxNotebookMachineSize	[`L`, `M`, `S`, `XS`]
ormVersion	[`v1`, `v2`, `v3`, `CCM`]

OrganizationUser

{
  "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
accessRoleIds	[string]	false	maxItems: 100	List of access role ids assigned to the user being created
create	boolean	false		If the user should be created if not found
firstName	string	false	maxLength: 100	First name of the user being created
language	string	false		Language selection for the user being created.
lastName	string	false	maxLength: 100	Last name of the user being created
orgAdmin	boolean	false		Is this user should be marked as an organizational admin
password	string	false	maxLength: 512 minLength: 8 minLength: 8	Password for the user being created. Should be specified if `create` set to `true`
requireClickthrough	boolean	false		Require the user being created to agree to a clickthrough
username	string	true		The username of the user to add to the organization

Enumerated Values¶

Property	Value
language	[`ar_001`, `de_DE`, `en`, `es_419`, `fr`, `ja`, `ko`, `pt_BR`, `test`, `uk_UA`]

OrganizationUserCreatedResponse

{
  "userId": "string"
}

Properties¶

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

OrganizationUserListResponse

{
  "count": 0,
  "data": [
    {
      "accessRoleIds": [
        "string"
      ],
      "activated": true,
      "expirationDate": "2019-08-24T14:15:22Z",
      "externalId": "string",
      "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		Number of items in current page.
data	[OrganizationUserResponse]	true	maxItems: 1000	List of users in the organization.
next	string(uri)¦null	true		URL pointing to the next page (if null, there is no next page)
previous	string(uri)¦null	true		URL pointing to the previous page (if null, there is no previous page

OrganizationUserPatch

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

Properties¶

Name	Type	Required	Restrictions	Description
accessRoleIds	[string]	false	maxItems: 100	List of access role ids assigned to the user
activated	boolean	false		Whether the organization user is activated.
expirationDate	string(date-time)	false		User expiration date
maxWorkers	integer	false	minimum: 0 (exclusive)	User max workers
orgAdmin	boolean	false		Mark user as an organizational admin
organizationId	string	false		Organization to move the user into (destination org).

OrganizationUserResponse

{
  "accessRoleIds": [
    "string"
  ],
  "activated": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "externalId": "string",
  "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	maxItems: 100	List of access role ids assigned to the user
activated	boolean	true		Whether the organization user is activated.
expirationDate	string(date-time)¦null	true		User expiration date
externalId	string	true		The external user ID
firstName	string¦null	true		First name of the user being created
id	string	true		The organization user identifier.
lastName	string¦null	true		Last name of the user being created
maxWorkers	integer	true		Maximum number of concurrent workers available to this user.
orgAdmin	boolean	true		Is this user should be marked as an organizational admin
organizationId	string	true		The organization identifier.
scheduledForDeletion	boolean	false		Whether the user is scheduled for deletion. Only set when a specific feature flag is configured.
username	string	true		The username of the user to add to the organization

PreviewPermadeleteStatus

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

Preview report id and associated status.

Properties¶

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

Enumerated Values¶

Property	Value
status	[`ABORTED`, `BLOCKED`, `COMPLETED`, `CREATED`, `ERROR`, `EXPIRED`, `INCOMPLETE`, `INITIALIZED`, `PAUSED`, `RUNNING`]

SummaryPermadeleteStatus

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

Report id and associated status.

Properties¶

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

Enumerated Values¶

Property	Value
status	[`ABORTED`, `BLOCKED`, `COMPLETED`, `CREATED`, `ERROR`, `EXPIRED`, `INCOMPLETE`, `INITIALIZED`, `PAUSED`, `RUNNING`]

UsageItem

{
  "resourceBundleId": "string",
  "resourceBundleName": "string",
  "usageUnit": "string",
  "usageValue": 0,
  "workloadId": "string",
  "workloadName": "string"
}

Properties¶

Name	Type	Required	Description
resourceBundleId	string	true	The identifier of the resource bundle
resourceBundleName	string	true	Human readable name of the resource bundle
usageUnit	string	true	The unit of measurement for the usage value
usageValue	number	true	Numeric measure of the usage
workloadId	string	true	The identifier of the workload
workloadName	string	true	Human readable name of the workload

UsageResponse

{
  "data": [
    {
      "resourceBundleId": "string",
      "resourceBundleName": "string",
      "usageUnit": "string",
      "usageValue": 0,
      "workloadId": "string",
      "workloadName": "string"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[UsageItem]	true	maxItems: 1000	Usage records

UserBulkCreate

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

Properties¶

Name	Type	Required	Restrictions	Description
add	[UserBulkCreateObject]	true	maxItems: 50 minItems: 1	List of User objects to create with associated RequestIds

UserBulkCreateObject

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

Properties¶

Name	Type	Required	Description
attributionId	string	false	User ID in external marketing systems (SFDC)
company	string	false	Company where the user works.
country	string(ISO 3166-1 alpha-2 code)	false	Country where the user lives.
defaultCatalogDatasetSampleSize	AdminSampleSize	false	Size of a sample to propose by default when enabling Fast Registration workflow.
expirationDate	string(date-time)	false	Datetime, RFC3339, at which the user should expire.
externalId	string	false	User ID in external IdP.
firstName	string	true	First name of the user being created.
jobTitle	string	false	Job Title the user has.
language	string	false	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	Last name of the user being created.
maxGpuWorkers	integer	false	Amount of user's available GPU workers.
maxIdleWorkers	integer	false	Amount of org workers that the user can utilize when idle.
maxUploadSize	integer	false	The upper limit for the allowed upload size for this user.
maxUploadSizeCatalog	integer	false	The upper limit for the allowed upload size in the AI catalog for this user.
maxWorkers	integer	false	Amount of user's available workers.
organizationId	string	false	ID of the organization to add the user to.
password	string	false	Creates user with this password, if blank sends username invite.
requestId	string	true	Caller-provided unique identifier for matching user create request to result in response
requireClickthroughAgreement	boolean	false	Boolean to require the user to agree to a clickthrough.
userType	string	true	External name for UserType such as AcademicUser, BasicUser, ProUser.
username	string	true	Email address of new user.

Enumerated Values¶

Property	Value
language	[`ar_001`, `de_DE`, `en`, `es_419`, `fr`, `ja`, `ko`, `pt_BR`, `test`, `uk_UA`]
userType	[`AcademicUser`, `BasicUser`, `ProUser`, `Covid19TrialUser`]

UserBulkCreateResponse

{
  "count": 0,
  "data": [
    {
      "data": {
        "message": "string",
        "notifyStatus": {
          "inviteLink": "http://example.com",
          "sentStatus": true
        },
        "userId": "string",
        "username": "string"
      },
      "requestId": "string",
      "statusCode": 100
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	Number of results within the data field.
data	[UserBulkCreateResponseObject]	true	maxItems: 50	List of User object results, corresponding to the creation request.

UserBulkCreateResponseData

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

Response message/data from this specific User creation request

Properties¶

Name	Type	Required	Description
message	string	false	Error or other response message from the creation request if present.
notifyStatus	NotifyStatus	false	User notification values.
userId	string	false	The ID of the user if created.
username	string	false	The username of the user if created.

UserBulkCreateResponseObject

{
  "data": {
    "message": "string",
    "notifyStatus": {
      "inviteLink": "http://example.com",
      "sentStatus": true
    },
    "userId": "string",
    "username": "string"
  },
  "requestId": "string",
  "statusCode": 100
}

Properties¶

Name	Type	Required	Restrictions	Description
data	UserBulkCreateResponseData	true		Response message/data from this specific User creation request
requestId	string	true		Caller-provided unique identifier for matching user create request to result in response
statusCode	integer	true	minimum: 100	HTTP status code for this user creation request

UserCreate

{
  "attributionId": "string",
  "company": "string",
  "country": "string",
  "defaultCatalogDatasetSampleSize": {
    "type": "rows",
    "value": 0
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "externalId": "string",
  "firstName": "string",
  "jobTitle": "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	Description
attributionId	string	false	User ID in external marketing systems (SFDC)
company	string	false	Company where the user works.
country	string(ISO 3166-1 alpha-2 code)	false	Country where the user lives.
defaultCatalogDatasetSampleSize	AdminSampleSize	false	Size of a sample to propose by default when enabling Fast Registration workflow.
expirationDate	string(date-time)	false	Datetime, RFC3339, at which the user should expire.
externalId	string	false	User ID in external IdP.
firstName	string	true	First name of the user being created.
jobTitle	string	false	Job Title the user has.
language	string	false	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	Last name of the user being created.
maxGpuWorkers	integer	false	Amount of user's available GPU workers.
maxIdleWorkers	integer	false	Amount of org workers that the user can utilize when idle.
maxUploadSize	integer	false	The upper limit for the allowed upload size for this user.
maxUploadSizeCatalog	integer	false	The upper limit for the allowed upload size in the AI catalog for this user.
maxWorkers	integer	false	Amount of user's available workers.
organizationId	string	false	ID of the organization to add the user to.
password	string	false	Creates user with this password, if blank sends username invite.
requireClickthroughAgreement	boolean	false	Boolean to require the user to agree to a clickthrough.
userType	string	true	External name for UserType such as AcademicUser, BasicUser, ProUser.
username	string	true	Email address of new user.

Enumerated Values¶

Property	Value
language	[`ar_001`, `de_DE`, `en`, `es_419`, `fr`, `ja`, `ko`, `pt_BR`, `test`, `uk_UA`]
userType	[`AcademicUser`, `BasicUser`, `ProUser`, `Covid19TrialUser`]

UserCreateResponse

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

Properties¶

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

UserGroupBulkDelete

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

Properties¶

Name	Type	Required	Restrictions	Description
groups	[UserGroupRetrieve]	true	maxItems: 100	The groups to remove.

UserGroupCreate

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

Properties¶

Name	Type	Required	Restrictions	Description
accessRoleId	string	false		The identifier of the access role assigned to the group.
description	string	false	maxLength: 1000	The description of this user group.
email	string	false		The email that can be used to contact this user group.
name	string	true	maxLength: 100	The name of the new user group. Must be unique.
orgId	string	true		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",
  "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	Description
accessRoleId	string¦null	true	The identifier of the access role assigned to the group.
accessRoleName	string¦null	true	The name of the access role assigned to the group.
accountPermissions	object	true	Account permissions of this user group. Each key is a permission name.
» additionalProperties	boolean	false	none
createdBy	string¦null	true	The identifier of the user who created this user group.
description	string¦null	true	The description of this user group.
email	string¦null	true	The email of this user group.
id	string	true	The identifier of the user group.
maxCustomDeployments	integer¦null	true	The number of maximum custom deployments available for users of this group.
maxCustomDeploymentsLimit	integer¦null	true	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	The upper limit for a number of EDA workers to be run for users of this user group.
maxRam	integer¦null	true	The upper limit for amount of RAM available to users of this user group.
maxUploadCatalogSizeLimit	integer¦null	true	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	The maximum allowed upload size for users of this group.
maxUploadSizeCatalog	integer¦null	true	The maximum allowed upload size in the AI catalog for users in this group.
maxUploadSizeLimit	integer¦null	true	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	The upper limit for a number of workers to be run for users of this user group.
membersCount	integer	true	The number of members in this user group.
name	string	true	The name of the user group.
orgId	string¦null	true	The identifier of the organization the user group belongs to.
orgName	string¦null	true	The name of the organization this user group belongs to.

UserGroupRetrieve

{
  "groupId": "string"
}

Properties¶

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

UserGroupUpdate

{
  "accessRoleId": "string",
  "accountPermissions": {
    "property1": true,
    "property2": true
  },
  "description": "string",
  "email": "string",
  "name": "string",
  "orgId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
accessRoleId	string¦null	false		The identifier of the access role to assign to the group.
accountPermissions	object	false		Account permissions to set for this user group. Each key is a permission name.
» additionalProperties	boolean	false		none
description	string	false	maxLength: 1000	The description of this user group.
email	string	false		The email of this user group.
name	string	false	maxLength: 100	The new name for the user group.
orgId	string	false		The id of the organization to assign the user group to.

UserGroupsListResponse

{
  "count": 0,
  "data": [
    {
      "accessRoleId": "string",
      "accessRoleName": "string",
      "accountPermissions": {
        "property1": true,
        "property2": true
      },
      "createdBy": "string",
      "description": "string",
      "email": "string",
      "id": "string",
      "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"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of items returned on this page.
data	[UserGroupResponse]	true	maxItems: 100	List of user groups that match the query condition.
next	string(uri)¦null	true		The URL to the next page.
previous	string(uri)¦null	true		The URL to the previous page.
totalCount	integer	true		The total number of items that match the query condition.

UserInGroup

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

Properties¶

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

Enumerated Values¶

Property	Value
status	[`active`, `inactive`]

Username

{
  "username": "string"
}

Properties¶

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

UsersPermadelete

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

Properties¶

Name	Type	Required	Restrictions	Description
orgId	string¦null	false		Organization which's users to be permanently deleted.
orphansOwner	string¦null	false		User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
userIds	[string]	false	maxItems: 100 minItems: 1	Users to be permanently deleted.

UsersPermadeleteDeleteReportParamsResponse

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

Properties¶

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

UsersPermadeleteJobResponse

{
  "message": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
message	string¦null	true		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": "ABORTED",
  "statusId": "string"
}

Properties¶

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

Enumerated Values¶

Property	Value
status	[`ABORTED`, `COMPLETED`, `ERROR`, `EXPIRED`, `INITIALIZED`, `RUNNING`]

UsersPermadeletePreviewJobResponse

{
  "message": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
message	string¦null	true		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": "ABORTED",
  "statusId": "string"
}

Properties¶

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

Enumerated Values¶

Property	Value
status	[`ABORTED`, `COMPLETED`, `ERROR`, `EXPIRED`, `INITIALIZED`, `RUNNING`]

UsersPermadeletePreviewStatistics

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

The users cleanup report statistics.

Properties¶

Name	Type	Required	Description
deploymentsWillBeAssignedNewOwner	integer	true	Number of deployments that will be assigned a new owner.
deploymentsWillBeDeleted	integer	true	Number of deployments that will be deleted.
deploymentsWillNotBeDeleted	integer	true	Number of deployments that will not be deleted.
errors	integer	true	Number of errors encountered during preview construction.
projectsWillBeAssignedNewOwner	integer	true	Number of projects that will be assigned a new owner.
projectsWillBeDeleted	integer	true	Number of projects that will be deleted.
projectsWillNotBeDeleted	integer	true	Number of projects that will not be deleted.
usersWillBeDeleted	integer	true	Number of users that will be deleted.
usersWillNotBeDeleted	integer	true	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		The users cleanup report statistics.
message	string¦null	true		May contain further details.

UsersPermadeleteResponse

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

The users cleanup delete parameters.

Properties¶

Name	Type	Required	Restrictions	Description
orgId	string¦null	false		Organization which's users to be permanently deleted.
orphansOwner	string¦null	false		User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
orphansOwnerName	string	false		User which becomes an owner of any projects or deployments that otherwise cause an error because they would be orphaned.
userIds	[string]	false	maxItems: 100 minItems: 1	Users to be permanently deleted.

UsersPermadeleteSummaryReportStatistics

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

The users cleanup summary report statistics.

Properties¶

Name	Type	Required	Description
deploymentsAssignedNewOwner	integer	true	Number of deployments that are assigned a new owner.
deploymentsDeleted	integer	true	Number of deployments that are deleted.
deploymentsNotDeleted	integer	true	Number of deployments that are not deleted.
errors	integer	true	Number of errors encountered during users deletion.
projectsAssignedNewOwner	integer	true	Number of projects that are assigned a new owner.
projectsDeleted	integer	true	Number of projects that are deleted.
projectsNotDeleted	integer	true	Number of projects that are not deleted.
usersDeleted	integer	true	Number of users that are deleted.
usersNotDeleted	integer	true	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		The users cleanup summary report statistics.
message	string¦null	true		May contain further details.