User Management

Download schema

Manage users associated with a deployment.

List users associated with a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

List users associated with a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

List users associated with a deployment › query Parameters

name

string

Name of the user to filter by.

order_by

string · enum

Criteria to use when ordering user listings.

Enum values:

name_asc

name_desc

Default: name_asc

page

integer · int32

page_size

integer · uint32

List users associated with a deployment › Responses

200

scaleway.datawarehouse.v1beta1.ListUsersResponse

scaleway.datawarehouse.v1beta1.User[]

List of users associated with the deployment.

total_count

integer · uint64

Total count of users associated with the deployment.

Create a new user for a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

Create a new user for a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Create a new user for a deployment › Request Body

name

string

Name of the user.

password

string

Password for the user.

is_admin

boolean

Indicates if the user is an administrator.

Create a new user for a deployment › Responses

200

scaleway.datawarehouse.v1beta1.User

name

string

Name of the user.

is_admin

boolean

Indicates if the user is an administrator.

Delete a user from a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

Delete a user from a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the user to delete.

Delete a user from a deployment › Request Body

Delete a user from a deployment › Responses

No data returned

Update an existing user for a deployment

PATCH

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

Update an existing user for a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the user.

Update an existing user for a deployment › Request Body

password

string

New password for the user.

is_admin

boolean

Updates the user administrator permissions.

Update an existing user for a deployment › Responses

200

scaleway.datawarehouse.v1beta1.User

name

string

Name of the user.

is_admin

boolean

Indicates if the user is an administrator.

Deployment Versions Database Management

List users associated with a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

List users associated with a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

List users associated with a deployment › query Parameters

name

string

Name of the user to filter by.

order_by

string · enum

Criteria to use when ordering user listings.

Enum values:

name_asc

name_desc

Default: name_asc

page

integer · int32

page_size

integer · uint32

List users associated with a deployment › Responses

200

scaleway.datawarehouse.v1beta1.ListUsersResponse

scaleway.datawarehouse.v1beta1.User[]

List of users associated with the deployment.

total_count

integer · uint64

Total count of users associated with the deployment.

Create a new user for a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

Create a new user for a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Create a new user for a deployment › Request Body

name

string

Name of the user.

password

string

Password for the user.

is_admin

boolean

Indicates if the user is an administrator.

Create a new user for a deployment › Responses

200

scaleway.datawarehouse.v1beta1.User

name

string

Name of the user.

is_admin

boolean

Indicates if the user is an administrator.

Delete a user from a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

Delete a user from a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the user to delete.

Delete a user from a deployment › Request Body

Delete a user from a deployment › Responses

No data returned

Update an existing user for a deployment

PATCH

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

Update an existing user for a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the user.

Update an existing user for a deployment › Request Body

password

string

New password for the user.

is_admin

boolean

Updates the user administrator permissions.

Update an existing user for a deployment › Responses

200

scaleway.datawarehouse.v1beta1.User

name

string

Name of the user.

is_admin

boolean

Indicates if the user is an administrator.