Users

Deprecated

Get users list.

get

Deprecated, use /api/v1/users instead. Return the list of users of the tenant.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

onlyCreatedByMebooleanOptional

Filter the returned entities to only those that created by the requesting subject

usersTypestringOptional

Available only when SSO enabled

Responses

200

The complete set of permissions.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/users

HTTPcURLJavaScriptPython

GET /v1/k8s/users HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "entityType": "regular-user",
    "tenantId": 1001,
    "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
    "permitAllClusters": false,
    "permittedClusters": [
      "71f69d83-ba66-4822-adf5-55ce55efd210"
    ],
    "roles": [
      "viewer"
    ],
    "createdAt": "2021-12-14T16:04:15.099Z"
  },
  null,
  {
    "email": "[email protected]",
    "lastLogin": "2021-12-14T16:04:15.099Z"
  }
]

Deprecated

Create a new user.

post

Deprecated endpoint. Use the new endpoint api/v1/users instead and api/v1/authorization/access-rules to give user permissions.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

emailstringRequired

Email address of the user.

Example: [email protected]

entityTypestring · enumOptional

The type of authentication entity.

Example: regular-userPossible values:

tenantIdinteger · int32Optional

The id of the tenant.

Example: 1001

passwordstringRequired

The user's password.

Example: secret!123

needToChangePasswordbooleanOptional

True if the user is requested to change his password upon next login.

Example: true

permitAllClustersbooleanOptionalExample: false

userIdstring · uuidOptional

Unique identifier of the user

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d

permittedClustersstring · uuid[]Optional

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

Responses

200

The complete set of permissions.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/v1/k8s/users

HTTPcURLJavaScriptPython

POST /v1/k8s/users HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "email": "[email protected]",
  "roles": [
    "viewer"
  ],
  "entityType": "regular-user",
  "tenantId": 1001,
  "password": "secret!123",
  "needToChangePassword": true,
  "permitAllClusters": false,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ]
}

{
  "email": "[email protected]",
  "roles": [
    "viewer"
  ],
  "entityType": "regular-user",
  "tenantId": 1001,
  "password": "secret!123",
  "needToChangePassword": true,
  "permitAllClusters": false,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ]
}

Deprecated

Get user details.

get

Get the details of a given user. This endpoint requires ADMIN, EDITOR or VIEWER role. Deprecated endpoint. Use the new endpoint api/v1/users/{userId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstring · uuidRequired

Unique identifier of the user

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d

Responses

200

User details.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/users/{userId}

HTTPcURLJavaScriptPython

GET /v1/k8s/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "email": "[email protected]",
  "lastLogin": "2021-12-14T16:04:15.099Z"
}

Deprecated

Update user details.

put

Update the details of a given user. This endpoint requires ADMIN role. Deprecated endpoint. Use the new endpoint api/v1/users/{userId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstring · uuidRequired

Unique identifier of the user

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d

Body

application/json

and

anyOptional

and

Responses

200

User updated successfully

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/v1/k8s/users/{userId}

HTTPcURLJavaScriptPython

PUT /v1/k8s/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "email": "[email protected]",
  "lastLogin": "2021-12-14T16:04:15.099Z"
}

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "email": "[email protected]",
  "lastLogin": "2021-12-14T16:04:15.099Z"
}

Deprecated

Delete a user.

delete

Delete the given user from the tenant. This endpoint requires ADMIN role. Deprecated endpoint. Use the new endpoint api/v1/users/{userId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstring · uuidRequired

Unique identifier of the user

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d

Query parameters

usersTypestringOptional

Available only when SSO enabled

Responses

200

User deleted successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/v1/k8s/users/{userId}

HTTPcURLJavaScriptPython

DELETE /v1/k8s/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Get all possible permissions.

get

Get the complete set of permissions that a tenant can grant to users and applications. Deprecated endpoint. please refer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

The complete set of permissions.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/users/roles

HTTPcURLJavaScriptPython

GET /v1/k8s/users/roles HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "viewer"
]

Deprecated

Get user permissions.

get

Return the set of permissions granted to a given user. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstring · uuidRequired

Unique identifier of the user

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d

Responses

200

A set of permissions that the user is granted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/users/{userId}/roles

HTTPcURLJavaScriptPython

GET /v1/k8s/users/{userId}/roles HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "viewer"
]

Deprecated

Get groups list.

get

Return the list of groups of the tenant. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

onlyCreatedByMebooleanOptional

Filter the returned entities to only those that created by the requesting subject

Responses

200

The complete set of permissions.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/groups

HTTPcURLJavaScriptPython

GET /v1/k8s/groups HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Deprecated

Create a new group.

post

Create a new group and assign it with roles. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

usernamestringRequired

Group's name

Example: group1

emailstringRequired

Empty email address

entityTypestringOptionalExample: sso-user

tenantIdinteger · int32Optional

The id of the tenant.

Example: 1001

permitAllClustersbooleanOptionalExample: false

userIdstringOptional

Group's name

Example: group1

permittedClustersstring · uuid[]Optional

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

createdBystringOptional

uid of the user

Example: aaaaa-3333-4444-bbbbbb-111

Responses

200

The complete set of permissions.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/v1/k8s/groups

HTTPcURLJavaScriptPython

POST /v1/k8s/groups HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "username": "group1",
  "email": "",
  "roles": [
    "viewer"
  ],
  "entityType": "sso-user",
  "tenantId": 1001,
  "permitAllClusters": false,
  "userId": "group1",
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "createdBy": "aaaaa-3333-4444-bbbbbb-111"
}

{
  "username": "group1",
  "email": "",
  "roles": [
    "viewer"
  ],
  "entityType": "sso-user",
  "tenantId": 1001,
  "permitAllClusters": false,
  "userId": "group1",
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "createdBy": "aaaaa-3333-4444-bbbbbb-111"
}

Deprecated

Get group details.

get

Get the details of a given group. This endpoint requires ADMIN, EDITOR or VIEWER role. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

groupNamestring · stringRequired

Unique identifier of the group

Example: group1

Responses

200

Group details.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/groups/{groupName}

HTTPcURLJavaScriptPython

GET /v1/k8s/groups/{groupName} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entityType": "group",
  "tenantId": 1001,
  "userId": "group1",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdBy": "aaaaa-3333-4444-bbbbbb-111"
}

Deprecated

Update group details.

put

Update the details of a given group. This endpoint requires ADMIN role. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

groupNamestring · stringRequired

Unique identifier of the group

Example: group1

Body

application/json

and

Responses

200

Group updated successfully

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/v1/k8s/groups/{groupName}

HTTPcURLJavaScriptPython

PUT /v1/k8s/groups/{groupName} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "entityType": "group",
  "tenantId": 1001,
  "userId": "group1",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdBy": "aaaaa-3333-4444-bbbbbb-111",
  "username": "group1"
}

{
  "entityType": "group",
  "tenantId": 1001,
  "userId": "group1",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdBy": "aaaaa-3333-4444-bbbbbb-111"
}

Deprecated

Delete a group.

delete

Delete the given group from the tenant. This endpoint requires ADMIN role. Deprecated endpoint. please reffer to Roles & Access rules API.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

groupNamestring · stringRequired

Unique identifier of the group

Example: group1

Responses

200

Group deleted successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/v1/k8s/groups/{groupName}

HTTPcURLJavaScriptPython

DELETE /v1/k8s/groups/{groupName} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get users.

get

Retrieve a list of platform users.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterstringOptionalDeprecated

Filter results by user attribute.

Example: runai.is_local:true

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are <= Less than or equal, >= Greater than or equal, =@ contains. Dates are in ISO 8601 timestamp format and available for operators <=, >= and ==.

Example: ["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 500

searchstringOptional

Filter results by a free text search.

Example: test@run

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "username": "[email protected]",
    "createdBy": "[email protected]",
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "lastLogin": "2023-02-01T00:00:00Z",
    "isLocal": true,
    "groups": [
      "groupA",
      "groupB"
    ]
  }
]

Create a local user.

post

Use to create a local platform user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

emailstringRequired

The email of the user. Must be a valid email address.

Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

resetPasswordboolean · nullableOptional

Responses

201

Created successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/users

HTTPcURLJavaScriptPython

POST /api/v1/users HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "email": "[email protected]",
  "resetPassword": false
}

{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "username": "[email protected]",
  "tempPassword": "asdasidjn9d"
}

Count users

get

count users

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are <= Less than or equal, >= Greater than or equal, =@ contains. Dates are in ISO 8601 timestamp format and available for operators <=, >= and ==.

Example: ["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]

searchstringOptional

Filter results by a free text search.

Example: test@run

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/users/count

HTTPcURLJavaScriptPython

GET /api/v1/users/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Logout a user.

post

Use to force a user to logout.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

Responses

200

Executed successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/users/{userId}/logout

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/logout HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reset a user's password.

post

Use to to reset a user's password.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

Responses

200

Regenerated successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/users/{userId}/password

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tempPassword": "asdasidjn9d"
}

Get a user by id.

get

Retrieve a user's details by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  "username": "[email protected]",
  "createdBy": "[email protected]",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2022-01-01T00:00:00Z",
  "lastLogin": "2023-02-01T00:00:00Z",
  "isLocal": true,
  "groups": [
    "groupA",
    "groupB"
  ]
}

Delete a user by id.

delete

Use to delete a user by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

Responses

204

Executed successfully.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

change user password

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

currentPasswordstringRequired

newPasswordstringRequired

Responses

200

Password changed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/me/password

HTTPcURLJavaScriptPython

POST /api/v1/me/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "currentPassword": "Abcd!234",
  "newPassword": "Zxcv!567"
}

{
  "tempPassword": "Abcd!234"
}