-
Notifications
You must be signed in to change notification settings - Fork 268
feat(iam): change iam doc structure #5980
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
| <ProductHeader | ||
| productName="Organization Security" | ||
| productLogo="iam" | ||
| description="Learn the measures you can undertake to secure access to the Organization." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| description="Learn the measures you can undertake to secure access to the Organization." | |
| description="Organization Security helps you protect your Scaleway environment. Enable MFA, configure SSO and identity federation, and manage authentication methods to secure your Scaleway Organization and meet your compliance needs." |
| productName="Organization Security" | ||
| productLogo="iam" | ||
| description="Learn the measures you can undertake to secure access to the Organization." | ||
| url="/organizations-security/concepts/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change links to Quickstart, for conformity
|
|
||
| ## Getting Started | ||
|
|
||
| <Grid> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add Quickstart and FAQ
| url="/organization-security/how-to/" | ||
| /> | ||
| </Grid> | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usually we also have a Changelog widget on the Overview page, which suggests we should also create a new Changelog category here?
|
|
||
| ## Alias | ||
|
|
||
| Each [Organization](#organization) can have an alias set up by an Organization Manager. Once set-up, all members can log in using a dedicated URL for the Organization using the alias, under the format [alias].account.scaleway.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Each [Organization](#organization) can have an alias set up by an Organization Manager. Once set-up, all members can log in using a dedicated URL for the Organization using the alias, under the format [alias].account.scaleway.com | |
| An alias is a string of characters used to identify the [Organization](#organizations-and-projects/concepts/#organization) during member login. Aliases can be used as an alternative to the Organization ID, to make memorization and access easier for members. | |
| Each Organization can have one alias, configured by an Organization Manager. Once set up, all members can log in via a dedicated URL, with the format [alias].account.scaleway.com |
|
|
||
| ## IAM manager | ||
|
|
||
| An IAM manager can be the Owner of the Organization, or any IAM member with permission sets enabling them to perform administrative actions in the Organization, such as managing members or enforcing Security Requierements. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| An IAM manager can be the Owner of the Organization, or any IAM member with permission sets enabling them to perform administrative actions in the Organization, such as managing members or enforcing Security Requierements. | |
| An IAM manager can be the Owner of the Organization, or any IAM member with permission sets enabling them to perform administrative actions in the Organization, such as managing members or enforcing security requirements. |
|
|
||
| ## Identity Provider | ||
|
|
||
| An Identity Provider (IdP) is a service that authenticates users and provides identity information to Scaleway to enable secure access through [Single Sign-On (SSO)](#single-sign-on) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| An Identity Provider (IdP) is a service that authenticates users and provides identity information to Scaleway to enable secure access through [Single Sign-On (SSO)](#single-sign-on) | |
| An **Id**entity **P**rovider (IdP) is a service that authenticates users and provides identity information to Scaleway as a third party. This enables secure access through mechanisms such as [Single Sign-On (SSO)](#single-sign-on). |
|
|
||
| ## Multi-Factor Authentication (MFA) | ||
|
|
||
| Multi-factor authentication (MFA) is a security method that requires users to verify their identity using two or more independent factors, such as something they know, have, or are, before logging into an [Organization](/organizations-and-projects/concepts/#organization). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should link to the existing concept in Account as well, which provides more information.
|
|
||
| ## SAML | ||
|
|
||
| Security Assertion Markup Language (SAML) is a standard protocol that enables secure authentication by exchanging identity and authorization data between an identity provider and a service provider. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Security Assertion Markup Language (SAML) is a standard protocol that enables secure authentication by exchanging identity and authorization data between an identity provider and a service provider. | |
| **S**ecurity **A**ssertion **M**arkup **L**anguage (SAML) is a standard protocol that enables secure authentication by exchanging identity and authorization data between an identity provider and a service provider. In relation to Scaleway, SAML enables Single Sign-On for Organizations, with external identity providers authenticating users for Scaleway (the service provider). |
|
|
||
| ## Security requirements | ||
|
|
||
| Security requirements are a set of actions that must be underdone by all members of an Organization to be compliant with its security standards. Security requirements can be enforced by an [IAM manager](#iam-manager). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Security requirements are a set of actions that must be underdone by all members of an Organization to be compliant with its security standards. Security requirements can be enforced by an [IAM manager](#iam-manager). | |
| Security requirements are a set of actions that must be undertaken by all members of an Organization to be compliant with its security standards. Security requirements can be enforced by an [IAM manager](#iam-manager). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following redirections would need to be put in place, also we need to correct links (indicated) from other pages:
/iam/how-to/log-in-as-a-member/ -- > /organization-security/how-to/log-in-as-a-member
- Also linked to from /demos/index, link needs updating
/iam/how-to/comply-with-sec-requirements-member/ -- > /organization-security/how-to/comply-with-sec-requirements-member
- Also linked to from /account/how-to/use-2fa, link needs updating
/iam/how-to/enforce-security-requirements-members/ --> /organization-security/how-to/enforce-security-requirements-members
- Also linked to from /use-cases/security/security-baseline, link needs updating
/organizations-and-projects/how-to/set-organization-alias/ --> /organization-security/how-to/set-organization-alias
- Also linked to from /account/how-to/log-in-to-the-console, link needs updating
/iam/how-to/set-up-identity-federation/ --> /organization-security/how-to/set-up-identity-federation
- Also linked to from /use-cases/security/security-baseline, link needs updating
/iam/how-to/set-up-sso-with-authentik/ --> /organization-security/how-to/set-up-sso-with-authentik
/organizations-and-projects/how-to/enforce-mfa/ --> /organization-security/how-to/enforce-mfa
|
|
||
| A condition is an additional layer of restrictions for your rule. You can allow access to specific user agents or IP addresses, and allow actions to be performed only at certain dates and times. Conditions are defined through [CEL](#common-expression-language-cel) expressions, and can be set up and configured in the Scaleway console. Refer to the [Understanding policy conditions](/iam/reference-content/understanding-policy-conditions) documentation page to learn how they are set up and how you can define them. | ||
|
|
||
| ## Grace period |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to replace links towards this anchor with the new URL (find in "/pages" /iam/concepts/#grace-period replace with /organization-security/concepts/#grace-period
Possible also check for links from the console
| label: 'Set up SSO with Authentik', | ||
| slug: 'set-up-sso-with-authentik' | ||
| }, | ||
| { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| { | |
| { |
Your checklist for this pull request
Description
Please describe what you added or changed.