Scaleway logo
IAM API

Security Settings

Security settings are organization-wide configurations that apply to all users in an organization. These settings enforce restrictions on how users authenticate with Scaleway's services.


Get security settings of an Organization

GET
https://api.scaleway.com
/iam/v1alpha1/organizations/{organization_id}/security-settings

Retrieve information about the security settings of an Organization, specified by the organization_id parameter.

Get security settings of an Organization › path Parameters

organization_id
​string · required

ID of the Organization.

Get security settings of an Organization › Responses

200
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)


Update the security settings of an Organization

PATCH
https://api.scaleway.com
/iam/v1alpha1/organizations/{organization_id}/security-settings

Update the security settings of an Organization › path Parameters

organization_id
​string · required

ID of the Organization.

Update the security settings of an Organization › Request Body

enforce_password_renewal
​boolean | null

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 | null · 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)

Update the security settings of an Organization › Responses

200
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)