From 955825182ae51057869b7342f401744a57a18bb2 Mon Sep 17 00:00:00 2001 From: nikosev Date: Thu, 14 Oct 2021 18:28:35 +0300 Subject: [PATCH] Fix some markdown syntax errors --- docs/developer/guide-for-sps.md | 19 ++++++++++--------- docs/manager/virtual-organisations.md | 20 ++++++++++---------- docs/manager/voms.md | 2 +- docs/user/signup.md | 22 +++++++++++----------- 4 files changed, 32 insertions(+), 31 deletions(-) diff --git a/docs/developer/guide-for-sps.md b/docs/developer/guide-for-sps.md index 1ca6571..0d0b91d 100644 --- a/docs/developer/guide-for-sps.md +++ b/docs/developer/guide-for-sps.md @@ -14,8 +14,8 @@ from in order to access your service. To integrate your Service Provider with the RCIAM service, you need to create a registration request using the -[RCIAM Federation Registry Portal](https://federation-demo.rciam.grnet.gr). You can also -use the Federation Registry portal to request the reconfiguration or +[RCIAM Federation Registry Portal](https://federation-demo.rciam.grnet.gr). You +can also use the Federation Registry portal to request the reconfiguration or deregistration of an existing deployed service. Service registration requests typically require approval by an administrator. Please refer to the [Federation Registry Documentation](https://federation.rciam.grnet.gr/docs) for @@ -208,10 +208,10 @@ the authenticated user. Before your service can use the RCIAM OIDC Provider for user login, you must submit a service registration request using -[Federation Registry](https://federation-demo.rciam.grnet.gr) in order to obtain OAuth -2.0 credentials. The client configuration should include the general information -about your service, as described in [General Information](#general-information) -section. +[Federation Registry](https://federation-demo.rciam.grnet.gr) in order to +obtain OAuth 2.0 credentials. The client configuration should include the +general information about your service, as described in +[General Information](#general-information) section. #### Obtaining OAuth 2.0 credentials @@ -362,7 +362,8 @@ will not be useful since the token request relies on the initial secret. ###### Client configuration To enable PKCE you need to go to the -[Manage Services Page](https://federation-demo.rciam.grnet.gr) and create/edit a client. +[Manage Services Page](https://federation-demo.rciam.grnet.gr) and create/edit +a client. In "Protocol" tab under "Token Endpoint Authentication Method" select "No authentication" and in "Crypto" tab under "Proof Key for Code Exchange (PKCE) Code Challenge Method" select "SHA-256 hash algorithm". @@ -1226,8 +1227,8 @@ urn:mace:example.org:res:example-res#rciam.example.org ### Identity Assurance -Based on the authentication method selected by the user, the RCIAM proxy assigns a -Identity Assurance, which is conveyed to the SP through both the +Based on the authentication method selected by the user, the RCIAM proxy +assigns a Identity Assurance, which is conveyed to the SP through both the `eduPersonAssurance` attribute and the Authentication Context Class (`AuthnContextClassRef`) of the SAML authentication response. RCIAM uses Assurance Profiles which distinguish between three Identity Assurance levels, diff --git a/docs/manager/virtual-organisations.md b/docs/manager/virtual-organisations.md index a95d48f..0acd687 100644 --- a/docs/manager/virtual-organisations.md +++ b/docs/manager/virtual-organisations.md @@ -13,7 +13,7 @@ In simple terms a Virtual Organisation (VO) is just a group of users. In RCIAM VOs are created to group researchers who aim to share resources across the services to achieve a common goal as part of a scientific collaboration. For a more formal definition of VO please look at the -[RCIAM Glossary](../glossary). +[RCIAM Glossary](../glossary.md). If you are interested in creating your own VO, please see instructions in the section [below](#vo-management). @@ -27,7 +27,7 @@ organised in a hierarchical structure for creating groups or subgroups within a VO. It is assumed that VO managers and members have already registered their RCIAM -account (A step-by-step guide is provided in this [link](../user/signup). +account (A step-by-step guide is provided in this [link](../user/signup.md). ### Registering your VO @@ -99,7 +99,7 @@ information for every (sub)group that you need to add/remove to/from your VO: - **Group name** - **Group description** - Optional, **Group manager(s)**, i.e. the RCIAM identifiers (in the form of - `"xxxxxxx@example.org"`) of one or more users responsible for managing the VO group + `"xyz@example.org"`) of one or more users responsible for managing the VO group members. Group managers can also appoint other users as (sub)group managers. The manager(s) of the VO (or any parent group) are implicitly managers of the group. You can provide additional RCIAM user identifiers to extend the list @@ -143,7 +143,7 @@ From the VO members list (see [Viewing VO members](#viewing-vo-members) above): ![VO population to edit](../../static/img/manager/vo-population-remove.png) -2. Under **Role Attributes** click **Delete** on the right of the COU entry of +1. Under **Role Attributes** click **Delete** on the right of the COU entry of interest (for example, vo.example.com). On success the selected row will be removed. In this example we removed the **group1.vo.example.org** that we previously added. @@ -170,7 +170,7 @@ by any VO admin. 1. Navigate to Co Person Role view ![CO person role view](../../static/img/manager/co-person-role-path.png) -2. Choose Affiliation from drop down list +1. Choose Affiliation from drop down list ![VO affiliation](../../static/img/manager/vo-affiliation.png) #### Update User's VO Role @@ -178,7 +178,7 @@ by any VO admin. 1. Navigate to Co Person Role view ![CO person role view](../../static/img/manager/co-person-role-path.png) -2. Choose Role from drop down list, if available, or add custom text if no list +1. Choose Role from drop down list, if available, or add custom text if no list is present. ![Role title](../../static/img/manager/role-title.png) Subsequently, RCIAM uses the CO Person's group membership and role @@ -253,7 +253,7 @@ From the steps defined [above](#managing-cou-admin-members): ![Manage Group Memberships link](../../static/img/manager/manage-group-link.png) -2. **Filter** out the CO Person you need to apply for the admin role. Use +1. **Filter** out the CO Person you need to apply for the admin role. Use **Given, Family Name, Email, Identifier** or a combination of the former. ![RCIAM CO people filter](../../static/img/manager/co-people-filter.png) @@ -314,7 +314,7 @@ be supported in the future. "VoId": "vo.example.org", "Person": { "Type": "CO", - "Id": "01234567890123456789@example.org" + "Id": "xyz@example.org" }, "Status": "Active", "ValidFrom": "2017-05-21", @@ -327,7 +327,7 @@ be supported in the future. 1. Retrieving the VO membership information for a given RCIAM ePUID: ```sh - curl -vX GET https://rciam.example.org/api/v1/VoMembers/01234567890123456789@example.org \ + curl -vX GET https://rciam.example.org/api/v1/VoMembers/xyz@example.org \ --user "example-client":"veryverysecret" ``` @@ -337,7 +337,7 @@ be supported in the future. [ { "id": 85, - "epuid": "01234567890123456789@example.org", + "epuid": "xyz@example.org", "vo_id": "vo.example.org", "valid_from": "2017-05-20T22:00:00.000Z", "valid_through": "2017-06-21T22:00:00.000Z", diff --git a/docs/manager/voms.md b/docs/manager/voms.md index 7173275..cceb42e 100755 --- a/docs/manager/voms.md +++ b/docs/manager/voms.md @@ -12,7 +12,7 @@ issued by Certification Authorities (CAs) part of the [EUGridPMA](https://www.eugridpma.org/) federation which is also part of [IGTF](https://www.igtf.net/) (International Global Trust Federation). -The role of a Certification Authoritie (CA) is to guarantee that users are who +The role of a Certification Authority (CA) is to guarantee that users are who they claim to be and are entitled to own their certificate. It is up to the users to discover which CA they should contact. In general, CAs are organised geographically and by research institutes. Each CA has its own procedure to diff --git a/docs/user/signup.md b/docs/user/signup.md index 2e89eaa..c4c8265 100755 --- a/docs/user/signup.md +++ b/docs/user/signup.md @@ -19,28 +19,28 @@ get started: ![RCIAM IdP discovery](../../static/img/user/idp-discovery.png) -2. Enter your login credentials to authenticate yourself with your Home +1. Enter your login credentials to authenticate yourself with your Home Organisation -3. After successful authentication, you may be prompted by your Home +1. After successful authentication, you may be prompted by your Home Organisation to consent to the release of personal information to the **RCIAM AAI Service Provider Proxy**. -4. After successful authentication, you will be redirected to the RCIAM account +1. After successful authentication, you will be redirected to the RCIAM account registration form. On the introductory page, click **Begin** to start the registration process. ![RCIAM sign up intro](../../static/img/user/sign-up-intro.png) -5. RCIAM requires some basic information from you, depending on the attributes +1. RCIAM requires some basic information from you, depending on the attributes released by your Identity Provider, you may need to provide the values of the missing attributes. ![RCIAM sign up attributes](../../static/img/user/sign-up-attributes.png) -6. On the registration form, click **Review Terms and Conditions** +1. On the registration form, click **Review Terms and Conditions** -7. If you agree to the Terms of Use, select the **I Agree** option. +1. If you agree to the Terms of Use, select the **I Agree** option. :::caution @@ -51,7 +51,7 @@ get started: ![RCIAM ToU agreement](../../static/img/user/tou-agreement.png) -8. Finally, click **Submit** to submit your request. +1. Finally, click **Submit** to submit your request. :::caution @@ -60,7 +60,7 @@ get started: :: -9. After submitting your request, RCIAM will send you an email with a +1. After submitting your request, RCIAM will send you an email with a verification link. After you click that link, you'll be taken to the request confirmation page. @@ -74,10 +74,10 @@ get started: ::: -10. After reviewing your request, click **Confirm** and re-authenticate yourself +1. After reviewing your request, click **Confirm** and re-authenticate yourself using the Identity Provider you selected before. -11. In the case of the **Sign Up** registration, you need to wait for an RCIAM User +1. In the case of the **Sign Up** registration, you need to wait for an RCIAM User Sponsor to approve your request to join the RCIAM User Community. Upon approval, RCIAM AAI will send you a notification email. @@ -109,6 +109,6 @@ member of and the roles assigned to the user within those Virtual Organisation. ### Linked identities Information about identites linked to your account. Check the -[guide for linking accounts](../user/linking) for more information. +[guide for linking accounts](../user/linking.md) for more information. ![Linked identities](../../static/img/user/profile-linked.png)