Skip to content

Commit

Permalink
Update IAM SAML Federation documentation (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
Icerzack authored Sep 10, 2024
1 parent 6a8572d commit 4b87dd2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
16 changes: 8 additions & 8 deletions website/docs/r/iam_saml_federation_certificate_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,23 @@ resource "selectel_iam_saml_federation_certificate_v1" "certificate" {

## Argument Reference

* `federation_id` - (Required) Federation ID.
* `federation_id` - (Required) Unique identifier of the federation.

* `name` - (Required) Certificate name.

* `description` - (Optional) Certificate description.

* `data` - (Required) Certificate data. It must begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----.
* `data` - (Required) Certificate data. Must begin with `-----BEGIN CERTIFICATE-----` and end with `-----END CERTIFICATE-----`.

## Attributes Reference

* `account_id` - Federation account ID.
* `account_id` - Selectel account ID. The account ID is in the top right corner of the [Control panel](https://my.selectel.ru/). Learn more about [Registration](https://docs.selectel.ru/en/control-panel-actions/account/registration/).

* `not_before` - Issuing date.
* `not_before` - Issue date of the certificate.

* `not_after` - End date.
* `not_after` - Expiration date of the certificate.

* `fingerprint` - Fingerprint.
* `fingerprint` - Fingerprint of the certificate.

## Import

Expand All @@ -64,6 +64,6 @@ where:

* `<password>` — Password of the service user.

* `<federtaion_id>` — Unique identifier of the Federation, which has this certificate, for example, `abc1bb378ac84e1234b869b77aadd2ab`. To get the federation ID, use either [Control Panel](https://my.selectel.ru/iam/federations) or [IAM API](https://developers.selectel.ru/docs/control-panel/iam/)
* `<federation_id>` — Unique identifier of the associated federation, for which the certificate is issued, for example, `abc1bb378ac84e1234b869b77aadd2ab`. To get the federation ID, use either [Control Panel](https://my.selectel.ru/iam/federations) or [IAM API](https://developers.selectel.ru/docs/control-panel/iam/).

* `<certificate_id>` — Unique identifier of the Certificate.
* `<certificate_id>` — Unique identifier of the certificate.
10 changes: 5 additions & 5 deletions website/docs/r/iam_saml_federation_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

Manages SAML Federation for Selectel products using public API v1.
Selectel products support Identity and Access Management (IAM).
For more information about Federations, see the [official Selectel documentation](https://docs.selectel.ru/en/control-panel-actions/users-and-roles/federations/).
For more information about federations, see the [official Selectel documentation](https://docs.selectel.ru/en/control-panel-actions/users-and-roles/federations/).

## Example Usage

Expand All @@ -30,19 +30,19 @@ resource "selectel_iam_saml_federation_v1" "federation_1" {

* `description` - (Optional) Federation description.

* `issuer` - (Required) ID of the credential provider.
* `issuer` - (Required) Identifier of the credential provider.

* `sso_url` - (Required) Link to the credential provider login page.

* `sign_authn_requests` - (Optional) Enable authentication requests signing.
* `sign_authn_requests` - (Optional) Enables signing of authentication requests.

* `force_authn` - (Optional) Require users to authenticate via SSO every time they log in.
* `force_authn` - (Optional) Requires users to authenticate via SSO every time they log in.

* `session_max_age_hours` - (Required) Session lifetime.

## Attributes Reference

* `account_id` - Federation account ID.
* `account_id` - Selectel account ID. The account ID is in the top right corner of the [Control panel](https://my.selectel.ru/). Learn more about [Registration](https://docs.selectel.ru/control-panel-actions/account/registration/).

## Import

Expand Down

0 comments on commit 4b87dd2

Please sign in to comment.