Scaleway logo
IAM API

scaleway.iam.v1alpha1.APIKey

access_key
​string

Access key of the API key.

secret_key
​string | null

Secret key of the API Key.

application_id
​string | null

ID of application that bears the API key.

user_id
​string | null

ID of user that bears the API key.

description
​string

Description of API key.

created_at
​string | null · date-time

Date and time of API key creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last API key update. (RFC 3339 format)

expires_at
​string | null · date-time

Date and time of API key expiration. (RFC 3339 format)

default_project_id
​string

Default Project ID specified for this API key.

editable
​boolean

Defines whether or not the API key is editable.

deletable
​boolean

Defines whether or not the API key is deletable.

managed
​boolean

Defines whether or not the API key is managed.

creation_ip
​string

IP address of the device that created the API key.

srn
​string

The SRN of the API key.

scaleway.iam.v1alpha1.Application

id
​string

ID of the application.

name
​string

Name of the application.

description
​string

Description of the application.

created_at
​string | null · date-time

Date and time application was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last application update. (RFC 3339 format)

organization_id
​string

ID of the Organization.

editable
​boolean

Defines whether or not the application is editable.

deletable
​boolean

Defines whether or not the application is deletable.

managed
​boolean

Defines whether or not the application is managed.

nb_api_keys
​integer · uint32

Number of API keys attributed to the application.

tags
​string[]

Tags associated with the user.

srn
​string

SRN of the application.

scaleway.iam.v1alpha1.BearerType

string · enum
Enum values:
unknown_bearer_type
user
application
Default: unknown_bearer_type

scaleway.iam.v1alpha1.CheckPermissionsRequest.Permission

service
​string
name
​string
action
​string
project_id
​string | null
organization_id
​string | null

scaleway.iam.v1alpha1.CheckPermissionsResponse

scaleway.iam.v1alpha1.CheckPermissionsResponse.Response

Enum values:
deny
allow
Default: deny

scaleway.iam.v1alpha1.CheckPermissionsResponse.Response.Decision

string · enum
Enum values:
deny
allow
Default: deny

scaleway.iam.v1alpha1.Connection

Information about the connected organization.

Information about the connected user.

scaleway.iam.v1alpha1.Connection.ConnectedOrganization

id
​string
name
​string
locked
​boolean

scaleway.iam.v1alpha1.Connection.ConnectedUser

id
​string
username
​string
type
​scaleway.iam.v1alpha1.User.Type · enum
Enum values:
unknown_type
owner
member
Default: unknown_type

scaleway.iam.v1alpha1.CreateScimTokenResponse

The SCIM token metadata.

bearer_token
​string

The Bearer Token to use to authenticate to SCIM endpoints.

scaleway.iam.v1alpha1.CreateUserRequest.Member

email
​string

Email of the user to create.

send_password_email
​boolean

Whether or not to send an email containing the member's password.

send_welcome_email
​boolean

Whether or not to send a welcome email that includes onboarding information.

username
​string

The member's username.

password
​string

The member's password.

first_name
​string

The member's first name.

last_name
​string

The member's last name.

phone_number
​string

The member's phone number.

locale
​string

The member's locale.

scaleway.iam.v1alpha1.GetUserConnectionsResponse

List of connections.

scaleway.iam.v1alpha1.GracePeriod

type
​scaleway.iam.v1alpha1.GracePeriodType · enum

Type of grace period.

Enum values:
unknown_grace_period_type
update_password
set_mfa
Default: unknown_grace_period_type
created_at
​string | null · date-time

Date and time the grace period was created. (RFC 3339 format)

expires_at
​string | null · date-time

Date and time the grace period expires. (RFC 3339 format)

scaleway.iam.v1alpha1.GracePeriodType

string · enum
Enum values:
unknown_grace_period_type
update_password
set_mfa
Default: unknown_grace_period_type

scaleway.iam.v1alpha1.Group

id
​string

ID of the group.

created_at
​string | null · date-time

Date and time of group creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last group update. (RFC 3339 format)

organization_id
​string

ID of Organization linked to the group.

name
​string

Name of the group.

description
​string

Description of the group.

user_ids
​string[]

IDs of users attached to this group.

application_ids
​string[]

IDs of applications attached to this group.

tags
​string[]

Tags associated to the group.

editable
​boolean

Defines whether or not the group is editable.

deletable
​boolean

Defines whether or not the group is deletable.

managed
​boolean

Defines whether or not the group is managed.

all_users
​boolean

Indicates if the group is the special "All Users" group that contains all users of the organization.

all_applications
​boolean

Indicates if the group is the special "All Applications" group that contains all non-managed applications of the organization.

srn
​string

The SRN of the group.

scaleway.iam.v1alpha1.InitiateUserConnectionResponse

token
​string

Token to be used in JoinUserConnection.

scaleway.iam.v1alpha1.JWT

jti
​string

JWT ID.

issuer_id
​string

ID of the user who issued the JWT.

audience_id
​string

ID of the user targeted by the JWT.

created_at
​string | null · date-time

Creation date of the JWT. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the JWT. (RFC 3339 format)

expires_at
​string | null · date-time

Expiration date of the JWT. (RFC 3339 format)

ip
​string

IP address used during the creation of the JWT. (IP address)

user_agent
​string

User-agent used during the creation of the JWT.

srn
​string

The SRN of the JWT.

scaleway.iam.v1alpha1.ListAPIKeysRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
expires_at_asc
expires_at_desc
access_key_asc
access_key_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListAPIKeysResponse

List of API keys.

total_count
​integer · uint32

Total count of API Keys.

scaleway.iam.v1alpha1.ListApplicationsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListApplicationsResponse

List of applications.

total_count
​integer · uint32

Total count of applications.

scaleway.iam.v1alpha1.ListGracePeriodsResponse

List of grace periods.

scaleway.iam.v1alpha1.ListGroupsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListGroupsResponse

List of groups.

total_count
​integer · uint32

Total count of groups.

scaleway.iam.v1alpha1.ListJWTsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListJWTsResponse

total_count
​integer · uint64

scaleway.iam.v1alpha1.ListLogsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListLogsResponse

List of logs.

total_count
​integer · uint64

Total count of logs.

scaleway.iam.v1alpha1.ListPermissionSetsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
created_at_asc
created_at_desc
Default: name_asc

scaleway.iam.v1alpha1.ListPermissionSetsResponse

List of permission sets.

total_count
​integer · uint32

Total count of permission sets.

scaleway.iam.v1alpha1.ListPoliciesRequest.OrderBy

string · enum
Enum values:
policy_name_asc
policy_name_desc
created_at_asc
created_at_desc
Default: policy_name_asc

scaleway.iam.v1alpha1.ListPoliciesResponse

List of policies.

total_count
​integer · uint32

Total count of policies.

scaleway.iam.v1alpha1.ListQuotaRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.iam.v1alpha1.ListQuotaResponse

List of quota.

total_count
​integer · uint64

Total count of quota.

scaleway.iam.v1alpha1.ListRulesResponse

Rules of the policy.

total_count
​integer · uint32

Total count of rules.

scaleway.iam.v1alpha1.ListSSHKeysRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListSSHKeysResponse

List of SSH keys.

total_count
​integer · uint32

Total count of SSH keys.

scaleway.iam.v1alpha1.ListSamlCertificatesResponse

List of SAML certificates.

scaleway.iam.v1alpha1.ListScimTokensRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.iam.v1alpha1.ListScimTokensResponse

List of SCIM tokens.

total_count
​integer · uint64

Total count of SCIM tokens.

scaleway.iam.v1alpha1.ListUsersRequest.OrderBy

string · enum
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

scaleway.iam.v1alpha1.ListUsersResponse

List of users.

total_count
​integer · uint32

Total count of users.

scaleway.iam.v1alpha1.LocalityType

string · enum
Enum values:
global
region
zone
Default: global

scaleway.iam.v1alpha1.Log

id
​string

Log ID. (UUID format)

created_at
​string | null · date-time

Creation date of the log. (RFC 3339 format)

ip
​string

IP address of the HTTP request linked to the log. (IP address)

user_agent
​string

User-Agent of the HTTP request linked to the log.

action
​scaleway.iam.v1alpha1.Log.Action · enum

Action linked to the log.

Enum values:
unknown_action
created
updated
deleted
Default: unknown_action
bearer_id
​string

ID of the principal at the origin of the log. (UUID format)

organization_id
​string

ID of Organization linked to the log. (UUID format)

resource_type
​scaleway.iam.v1alpha1.Log.ResourceType · enum

Type of the resource linked to the log.

Enum values:
unknown_resource_type
api_key
user
application
group
policy
Default: unknown_resource_type
resource_id
​string

ID of the resource linked to the log.

srn
​string

The SRN of the log.

scaleway.iam.v1alpha1.Log.Action

string · enum
Enum values:
unknown_action
created
updated
deleted
Default: unknown_action

scaleway.iam.v1alpha1.Log.ResourceType

string · enum
Enum values:
unknown_resource_type
api_key
user
application
group
policy
Default: unknown_resource_type

scaleway.iam.v1alpha1.MFAOTP

secret
​string

scaleway.iam.v1alpha1.Organization

id
​string

ID of the Organization.

name
​string

Name of the Organization.

alias
​string

Alias of the Organization.

login_password_enabled
​boolean

Defines whether login with a password is enabled for the Organization.

login_magic_code_enabled
​boolean

Defines whether login with an authentication code is enabled for the Organization.

login_oauth2_enabled
​boolean

Defines whether login through OAuth2 is enabled for the Organization.

login_saml_enabled
​boolean

Defines whether login through SAML is enabled for the Organization.

scaleway.iam.v1alpha1.OrganizationSecuritySettings

enforce_password_renewal
​boolean

Defines whether password renewal is enforced during first login.

grace_period_duration
​string | null

Duration of the grace period to renew password or enable MFA. (in seconds)

login_attempts_before_locked
​integer · uint32

Number of login attempts before the account is locked.

max_login_session_duration
​string | null

Maximum duration a login session will stay active before needing to relogin. (in seconds)

max_api_key_expiration_duration
​string | null

Maximum duration the expires_at field of an API key can represent. A value of 0 means there is no maximum duration. (in seconds)

scaleway.iam.v1alpha1.PermissionSet

id
​string

Id of the permission set.

name
​string

Name of the permission set.

scope_type
​scaleway.iam.v1alpha1.PermissionSet.ScopeType · enum

Scope of the permission set.

Enum values:
unknown_scope_type
projects
organization
account_root_user
Default: unknown_scope_type
description
​string

Description of the permission set.

categories
​array | null

Categories of the permission set.

scaleway.iam.v1alpha1.PermissionSet.ScopeType

string · enum
Enum values:
unknown_scope_type
projects
organization
account_root_user
Default: unknown_scope_type

scaleway.iam.v1alpha1.Policy

id
​string

Id of the policy.

name
​string

Name of the policy.

description
​string

Description of the policy.

organization_id
​string

Organization ID of the policy.

created_at
​string | null · date-time

Date and time of policy creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last policy update. (RFC 3339 format)

editable
​boolean

Defines whether or not a policy is editable.

deletable
​boolean

Defines whether or not a policy is deletable.

managed
​boolean

Defines whether or not a policy is managed.

nb_rules
​integer · uint32

Number of rules of the policy.

nb_scopes
​integer · uint32

Number of policy scopes.

nb_permission_sets
​integer · uint32

Number of permission sets of the policy.

tags
​string[]

Tags associated with the policy.

user_id
​string | null

ID of the user attributed to the policy.

group_id
​string | null

ID of the group attributed to the policy.

application_id
​string | null

ID of the application attributed to the policy.

no_principal
​boolean | null

Defines whether or not a policy is attributed to a principal.

srn
​string

The SRN of the policy.

scaleway.iam.v1alpha1.Quotum

name
​string

Name of the quota.

pretty_name
​string

A human-readable name for the quota.

unit
​string

The unit in which the quota is expressed.

description
​string

Details about the quota.

locality_type
​scaleway.iam.v1alpha1.LocalityType · enum

Whether this quotum is applied on at the zone level, region level, or globally.

Enum values:
global
region
zone
Default: global

Limits per locality.

srn
​string

The SRN of the quotum.

scaleway.iam.v1alpha1.Quotum.Limit

global
​boolean | null

Whether or not the limit is applied globally.

region
​string | null

The region on which the limit is applied.

zone
​string | null

The zone on which the limit is applied.

limit
​integer | null · uint64

Maximum locality limit.

unlimited
​boolean | null

Whether or not the quota per locality is unlimited.

scaleway.iam.v1alpha1.Rule

id
​string

Id of rule.

permission_set_names
​array | null

Names of permission sets bound to the rule.

permission_sets_scope_type
​scaleway.iam.v1alpha1.PermissionSet.ScopeType · enum

Permission_set_names have the same scope_type.

Enum values:
unknown_scope_type
projects
organization
account_root_user
Default: unknown_scope_type
condition
​string

Condition expression to evaluate.

project_ids
​array | null

List of Project IDs the rule is scoped to.

organization_id
​string | null

ID of Organization the rule is scoped to.

account_root_user_id
​string | null

ID of account root user the rule is scoped to.

srn
​string

The SRN of the rule.

scaleway.iam.v1alpha1.RuleSpecs

permission_set_names
​array | null

Names of permission sets bound to the rule.

condition
​string

Condition expression to evaluate.

project_ids
​array | null

List of Project IDs the rule is scoped to.

organization_id
​string | null

ID of Organization the rule is scoped to.

scaleway.iam.v1alpha1.SSHKey

id
​string

ID of SSH key.

name
​string

Name of SSH key.

public_key
​string

Public key of SSH key.

fingerprint
​string

Fingerprint of the SSH key.

created_at
​string | null · date-time

Creation date of SSH key. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of SSH key. (RFC 3339 format)

organization_id
​string

ID of Organization linked to the SSH key.

project_id
​string

ID of Project linked to the SSH key.

disabled
​boolean

SSH key status.

srn
​string

The SRN of the SSH key.

scaleway.iam.v1alpha1.Saml

id
​string

ID of the SAML configuration.

status
​scaleway.iam.v1alpha1.Saml.Status · enum

Status of the SAML configuration.

Enum values:
unknown_saml_status
valid
missing_certificate
missing_entity_id
missing_single_sign_on_url
Default: unknown_saml_status

Service Provider information.

entity_id
​string

Entity ID of the SAML Identity Provider.

single_sign_on_url
​string

Single Sign-On URL of the SAML Identity Provider.

srn
​string

The SRN of the SAML.

scaleway.iam.v1alpha1.Saml.ServiceProvider

entity_id
​string
assertion_consumer_service_url
​string

scaleway.iam.v1alpha1.Saml.Status

string · enum
Enum values:
unknown_saml_status
valid
missing_certificate
missing_entity_id
missing_single_sign_on_url
Default: unknown_saml_status

scaleway.iam.v1alpha1.SamlCertificate

id
​string

ID of the SAML certificate.

type
​scaleway.iam.v1alpha1.SamlCertificate.Type · enum

Type of the SAML certificate.

Enum values:
unknown_certificate_type
signing
encryption
Default: unknown_certificate_type
origin
​scaleway.iam.v1alpha1.SamlCertificate.Origin · enum

Origin of the SAML certificate.

Enum values:
unknown_certificate_origin
scaleway
identity_provider
Default: unknown_certificate_origin
content
​string

Content of the SAML certificate.

expires_at
​string | null · date-time

Date and time of the SAML certificate expiration. (RFC 3339 format)

srn
​string

The SRN of the SAML certificate.

scaleway.iam.v1alpha1.SamlCertificate.Origin

string · enum
Enum values:
unknown_certificate_origin
scaleway
identity_provider
Default: unknown_certificate_origin

scaleway.iam.v1alpha1.SamlCertificate.Type

string · enum
Enum values:
unknown_certificate_type
signing
encryption
Default: unknown_certificate_type

scaleway.iam.v1alpha1.Scim

id
​string

ID of the SCIM configuration.

created_at
​string | null · date-time

Date and time of SCIM configuration creation. (RFC 3339 format)

scaleway.iam.v1alpha1.ScimToken

id
​string

(UUID format)

scim_id
​string

(UUID format)

created_at
​string | null · date-time

(RFC 3339 format)

expires_at
​string | null · date-time

(RFC 3339 format)

scaleway.iam.v1alpha1.SetRulesResponse

Rules of the policy.

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 | null · date-time

Date user was created. (RFC 3339 format)

updated_at
​string | null · 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 | null · date-time

Date of the last login. (RFC 3339 format)

type
​scaleway.iam.v1alpha1.User.Type · 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.

srn
​string

The SRN of the user.

scaleway.iam.v1alpha1.User.Status

string · enum
Enum values:
unknown_status
invitation_pending
activated
Default: unknown_status

scaleway.iam.v1alpha1.User.Type

string · enum
Enum values:
unknown_type
owner
member
Default: unknown_type

scaleway.iam.v1alpha1.ValidateUserMFAOTPResponse

recovery_codes
​string[]

List of recovery codes usable for this OTP method.