Users

Download schema

A user (or IAM user) is a human user in an Organization. They can be the Owner of an Organization linked to their Scaleway account, a Guest in another Organization, or a Member exclusive to a single Organization, not owning an Organization of their own. Each Organization can have IAM users with varying rights over resources, depending on its IAM policies.

List grace periods of a member

GET

https://api.scaleway.com

/iam/v1alpha1/grace-periods

List the grace periods of a member.

List grace periods of a member › query Parameters

user_id

string

ID of the user to list grace periods for.

List grace periods of a member › Responses

200

scaleway.iam.v1alpha1.ListGracePeriodsResponse

scaleway.iam.v1alpha1.GracePeriod[]

List of grace periods.

List users of an Organization

GET

https://api.scaleway.com

/iam/v1alpha1/users

List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the order_by field. You must define the organization_id in the query path of your request. You can also define additional parameters for your query such as user_ids.

List users of an Organization › query Parameters

order_by

string · enum

Criteria for sorting results.

Enum values:

created_at_asc

created_at_desc

updated_at_asc

updated_at_desc

email_asc

email_desc

last_login_asc

last_login_desc

Default: created_at_asc

page_size

integer · uint32

Number of results per page. Value must be between 1 and 100.

page

integer · int32

Page number. Value must be greater or equal to 1.

organization_id

string

ID of the Organization to filter.

user_ids

string[]

Filter by list of IDs.

mfa

boolean

Filter by MFA status.

tag

string

Filter by tags containing a given string.

type

string · enum

Filter by user type.

Enum values:

unknown_type

owner

member

Default: unknown_type

List users of an Organization › Responses

200

scaleway.iam.v1alpha1.ListUsersResponse

scaleway.iam.v1alpha1.User[]

List of users.

total_count

integer · uint32

Total count of users.

GET/iam/v1alpha1/users

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/iam/v1alpha1/users?organization_id=string"

Example Responses

{
  "users": [
    {
      "id": "id",
      "email": "email",
      "username": "username",
      "first_name": "first_name",
      "last_name": "last_name",
      "phone_number": "phone_number",
      "locale": "locale",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "organization_id": "organization_id",
      "deletable": true,
      "last_login_at": "2022-03-22T12:34:56.123456Z",
      "type": "unknown_type",
      "two_factor_enabled": true,
      "status": "unknown_status",
      "mfa": true,
      "account_root_user_id": "account_root_user_id",
      "tags": [
        "string"
      ],
      "locked": true
    }
  ],
  "total_count": 0
}

json

application/json

Create a new user

POST

https://api.scaleway.com

/iam/v1alpha1/users

Create a new user. You must define the organization_id in your request. If you are adding a member, enter the member's details. If you are adding a guest, you must define the email and not add the member attribute.

Create a new user › Request Body

organization_id

string · required

ID of the Organization.

email

string

Email of the user.

tags

string[]

Tags associated with the user.

object

Details of IAM member.

Create a new user › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

POST/iam/v1alpha1/users

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"organization_id":"string"}' \
  "https://api.scaleway.com/iam/v1alpha1/users"

Example Request Body

{
  "organization_id": "organization_id",
  "email": "email",
  "tags": [
    "string"
  ],
  "member": {
    "email": "email",
    "send_password_email": true,
    "send_welcome_email": true,
    "username": "username",
    "password": "password",
    "first_name": "first_name",
    "last_name": "last_name",
    "phone_number": "phone_number",
    "locale": "locale"
  }
}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Get a given user

GET

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}

Retrieve information about a user, specified by the user_id parameter. The user's full details, including id, email, organization_id, status and mfa are returned in the response.

Get a given user › path Parameters

user_id

string · required

ID of the user to find.

Get a given user › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

Delete a guest user from an Organization

DELETE

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}

Remove a user from an Organization in which they are a guest. You must define the user_id in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned.

Delete a guest user from an Organization › path Parameters

user_id

string · required

ID of the user to delete.

Delete a guest user from an Organization › Responses

No data returned

Update a user

PATCH

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}

Update the parameters of a user, including tags.

Update a user › path Parameters

user_id

string · required

ID of the user to update.

Update a user › Request Body

tags

string[]

New tags for the user (maximum of 10 tags).

email

string

IAM member email.

first_name

string

IAM member first name.

last_name

string

IAM member last name.

phone_number

string

IAM member phone number.

locale

string

IAM member locale.

Update a user › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

PATCH/iam/v1alpha1/users/{user_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/iam/v1alpha1/users/{user_id}"

Example Request Body

{
  "tags": [
    "string"
  ],
  "email": "email",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale"
}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Lock a member

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/lock

Lock a member. A locked member cannot log in or use API keys until the locked status is removed.

Lock a member › path Parameters

user_id

string · required

ID of the user to lock.

Lock a member › Request Body

Lock a member › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

POST/iam/v1alpha1/users/{user_id}/lock

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/iam/v1alpha1/users/{user_id}/lock"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Create a MFA OTP.

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/mfa-otp

Create a MFA OTP. › path Parameters

user_id

string · required

User ID of the MFA OTP.

Create a MFA OTP. › Request Body

Create a MFA OTP. › Responses

200

scaleway.iam.v1alpha1.MFAOTP

secret

string

Delete a MFA OTP.

DELETE

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/mfa-otp

Delete a MFA OTP. › path Parameters

user_id

string · required

User ID of the MFA OTP.

Delete a MFA OTP. › Request Body

Delete a MFA OTP. › Responses

No data returned

Unlock a member

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/unlock

Unlock a member › path Parameters

user_id

string · required

ID of the user to unlock.

Unlock a member › Request Body

Unlock a member › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

POST/iam/v1alpha1/users/{user_id}/unlock

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/iam/v1alpha1/users/{user_id}/unlock"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Update an user's password.

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/update-password

Update an user's password. › path Parameters

user_id

string · required

ID of the user to update.

Update an user's password. › Request Body

password

string · required

The new password.

Update an user's password. › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

POST/iam/v1alpha1/users/{user_id}/update-password

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"password":"string"}' \
  "https://api.scaleway.com/iam/v1alpha1/users/{user_id}/update-password"

Example Request Body

{
  "password": "password"
}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Update an user's username.

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/update-username

Update an user's username. › path Parameters

user_id

string · required

ID of the user to update.

Update an user's username. › Request Body

username

string · required

The new username.

Update an user's username. › Responses

200

scaleway.iam.v1alpha1.User

id

string

ID of user.

email

string

Email of user.

username

string

User identifier unique to the Organization.

first_name

string

First name of the user.

last_name

string

Last name of the user.

phone_number

string

Phone number of the user.

locale

string

Locale of the user.

created_at

string · date-time

Date user was created. (RFC 3339 format)

updated_at

string · date-time

Date of last user update. (RFC 3339 format)

organization_id

string

ID of the Organization.

deletable

boolean

Deletion status of user. Owners cannot be deleted.

last_login_at

string · date-time

Date of the last login. (RFC 3339 format)

type

string · enum

Type of user.

Enum values:

unknown_type

owner

member

Default: unknown_type

mfa

boolean

Defines whether MFA is enabled.

account_root_user_id

string

ID of the account root user associated with the user.

tags

string[]

Tags associated with the user.

locked

boolean

Defines whether the user is locked.

POST/iam/v1alpha1/users/{user_id}/update-username

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username":"string"}' \
  "https://api.scaleway.com/iam/v1alpha1/users/{user_id}/update-username"

Example Request Body

{
  "username": "username"
}

json

Example Responses

{
  "id": "id",
  "email": "email",
  "username": "username",
  "first_name": "first_name",
  "last_name": "last_name",
  "phone_number": "phone_number",
  "locale": "locale",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "organization_id": "organization_id",
  "deletable": true,
  "last_login_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type",
  "two_factor_enabled": true,
  "status": "unknown_status",
  "mfa": true,
  "account_root_user_id": "account_root_user_id",
  "tags": [
    "string"
  ],
  "locked": true
}

json

application/json

Validate a MFA OTP.

POST

https://api.scaleway.com

/iam/v1alpha1/users/{user_id}/validate-mfa-otp

Validate a MFA OTP. › path Parameters

user_id

string · required

User ID of the MFA OTP.

Validate a MFA OTP. › Request Body

one_time_password

string

A password generated using the OTP.

Validate a MFA OTP. › Responses

200

scaleway.iam.v1alpha1.ValidateUserMFAOTPResponse

recovery_codes

string[]

List of recovery codes usable for this OTP method.

API Keys Applications