Skip to content

Commit

Permalink
Merge pull request #2056 from exitcode0/import_docs
Browse files Browse the repository at this point in the history
Documentation: fix square bracket character encoding
  • Loading branch information
duytiennguyen-okta committed Aug 12, 2024
2 parents 7a1c090 + 8191c74 commit a020024
Show file tree
Hide file tree
Showing 82 changed files with 104 additions and 94 deletions.
2 changes: 1 addition & 1 deletion docs/resources/admin_role_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ resource "okta_admin_role_custom" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_admin_role_custom.example <custom role id&#62
terraform import okta_admin_role_custom.example <custom_role_id>
```
2 changes: 1 addition & 1 deletion docs/resources/admin_role_custom_assignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ resource "okta_group" "test" {
Import is supported using the following syntax:

```shell
terraform import okta_admin_role_custom_assignments.example &#60;resource_set_id&#62;/&#60;custom_role_id&#62;
terraform import okta_admin_role_custom_assignments.example <resource_set_id>/<custom_role_id>
```
4 changes: 2 additions & 2 deletions docs/resources/admin_role_targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ resource "okta_admin_role_targets" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_admin_role_targets.example &#60;user id&#62;/&#60;role type&#62;
```
terraform import okta_admin_role_targets.example <user_id>/<role_type>
```
4 changes: 2 additions & 2 deletions docs/resources/app_access_policy_assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ resource "okta_app_access_policy_assignment" "assignment" {
Import is supported using the following syntax:

```shell
terraform import okta_app_access_policy_assignment.example &#60;app id&#62;
```
terraform import okta_app_access_policy_assignment.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_auto_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_auto_login.example &#60;app id&#62
terraform import okta_app_auto_login.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_basic_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_basic_auth.example &#60;app id&#62
terraform import okta_app_basic_auth.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_bookmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_bookmark.example &#60;app id&#62t
terraform import okta_app_bookmark.example <app_id>
```
4 changes: 2 additions & 2 deletions docs/resources/app_group_assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_group_assignment.example &#60;app_id&#62;/&#60;group_id&#62
```
terraform import okta_app_group_assignment.example <app_id>/<group_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_group_assignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_group_assignments.example &#60;app_id&#62
terraform import okta_app_group_assignments.example <app_id>
```
4 changes: 2 additions & 2 deletions docs/resources/app_oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_oauth.example &#60;app id&#62
terraform import okta_app_oauth.example <app_id>
```


Expand Down Expand Up @@ -276,4 +276,4 @@ resource "okta_app_oauth" "app" {
#
# Pretty print OAuth app Client ID
# terraform show -json | jq -r '.values.root_module.resources[] | select(.address == "okta_app_oauth.app").values.id'
```
```
2 changes: 1 addition & 1 deletion docs/resources/app_oauth_api_scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ resource "okta_app_oauth_api_scope" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_app_oauth_api_scope.example &#60;app id&#62
terraform import okta_app_oauth_api_scope.example <app_id>
```
4 changes: 2 additions & 2 deletions docs/resources/app_oauth_post_logout_redirect_uri.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ resource "okta_app_oauth_post_logout_redirect_uri" "test" {
Import is supported using the following syntax:

```shell
terraform import okta_app_oauth_post_logout_redirect_uri.example &#60;app id&#62;/&#60;uri&#62
```
terraform import okta_app_oauth_post_logout_redirect_uri.example <app_id>/<uri>
```
4 changes: 2 additions & 2 deletions docs/resources/app_oauth_redirect_uri.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ resource "okta_app_oauth_redirect_uri" "test" {
Import is supported using the following syntax:

```shell
terraform import okta_app_oauth_redirect_uri.example &#60;app id&#62;/&#60;uri&#62
```
terraform import okta_app_oauth_redirect_uri.example <app_id>/<uri>
```
2 changes: 1 addition & 1 deletion docs/resources/app_saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,5 +281,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
terraform import okta_app_saml.example &#60;app id&#62
terraform import okta_app_saml.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_saml_app_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ resource "okta_app_saml_app_settings" "test" {
Import is supported using the following syntax:

```shell
terraform import okta_app_saml_app_settings.example &#60;app id&#62
terraform import okta_app_saml_app_settings.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_secure_password_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_secure_password_store.example &#60;app id&#62
terraform import okta_app_secure_password_store.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_shared_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_shared_credentials.example &#60;app id&#62
terraform import okta_app_shared_credentials.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_signon_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,5 @@ resource "okta_app_signon_policy_rule" "some_rule" {
Import is supported using the following syntax:

```shell
terraform import okta_app_signon_policy_rule.example &#60;policy_id&#62;
terraform import okta_app_signon_policy_rule.example <policy_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_signon_policy_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,5 +325,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_signon_policy_rule.example &#60;policy_id&#62;/&#60;rule_id&#62
terraform import okta_app_signon_policy_rule.example <policy_id>/<rule_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_swa.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_swa.example &#60;app id&#62;
terraform import okta_app_swa.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_three_field.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_app_three_field.example &#60;app id&#62;
terraform import okta_app_three_field.example <app_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ resource "okta_app_user" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_app_user.example &#60;app id&#62;/&#60;user id&#62;
terraform import okta_app_user.example <app_id>/<user_id>
```
2 changes: 1 addition & 1 deletion docs/resources/app_user_base_schema_property.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ resource "okta_app_user_base_schema_property" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_app_user_base_schema_property.example &#60;app id&#62;/&#60;property name&#62;
terraform import okta_app_user_base_schema_property.example <app_id>/<property_name>
```
2 changes: 1 addition & 1 deletion docs/resources/app_user_schema_property.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ Required:
Import is supported using the following syntax:

```shell
terraform import okta_app_user_schema_property.example &#60;app id&#62;/&#60;property name&#62;
terraform import okta_app_user_schema_property.example <app_id>/<property_name>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ resource "okta_auth_server" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server.example &#60;auth server id&#62;
terraform import okta_auth_server.example <auth_server_id>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_claim.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ resource "okta_auth_server_claim" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_claim.example &#60;auth server id&#62;/&#60;claim id&#62;
terraform import okta_auth_server_claim.example <auth_server_id>/<claim_id>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_claim_default.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ resource "okta_auth_server_claim_default" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_claim_default.example &#60;auth server id&#62;/&#60;claim name&#62;
terraform import okta_auth_server_claim_default.example <auth_server_id>/<claim_name>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_default.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ resource "okta_auth_server_default" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_default.example &#60;default&#62;
terraform import okta_auth_server_default.example <default>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ resource "okta_auth_server_policy" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_policy.example &#60;auth server id&#62;/&#60;policy id&#62;
terraform import okta_auth_server_policy.example <auth_server_id>/<policy_id>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_policy_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ resource "okta_auth_server_policy_rule" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_policy_rule.example &#60;auth server id&#62;/&#60;policy id&#62;/&#60;policy rule id&#62;
terraform import okta_auth_server_policy_rule.example <auth_server_id>/<policy_id>/<policy_rule_id>
```
2 changes: 1 addition & 1 deletion docs/resources/auth_server_scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ resource "okta_auth_server_scope" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_auth_server_scope.example &#60;auth server id&#62;/&#60;scope id&#62;
terraform import okta_auth_server_scope.example <auth_server_id>/<scope_id>
```
2 changes: 1 addition & 1 deletion docs/resources/authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,5 +104,5 @@ resource "okta_authenticator" "otp" {
Import is supported using the following syntax:

```shell
terraform import okta_authenticator.example &#60;authenticator_id&#62;
terraform import okta_authenticator.example <authenticator_id>
```
2 changes: 1 addition & 1 deletion docs/resources/behavior.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ resource "okta_behavior" "my_velocity" {
Import is supported using the following syntax:

```shell
terraform import okta_behavior.example &#60;behavior id&#62;
terraform import okta_behavior.example <behavior_id>
```
2 changes: 1 addition & 1 deletion docs/resources/brand.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ resource "okta_brand" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_brand.example &#60;brand id&#62;
terraform import okta_brand.example <brand_id>
```
2 changes: 1 addition & 1 deletion docs/resources/captcha.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ resource "okta_captcha" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_captcha.example &#60;captcha id&#62;
terraform import okta_captcha.example <captcha_id>
```
2 changes: 1 addition & 1 deletion docs/resources/customized_signin_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_customized_signin_page.example &#60;customized_signin_page_id&#62;
terraform import okta_customized_signin_page.example <customized_signin_page_id>
```
2 changes: 1 addition & 1 deletion docs/resources/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
terraform import okta_domain.example &#60;domain_id&#62;
terraform import okta_domain.example <domain_id>
```
2 changes: 1 addition & 1 deletion docs/resources/email_customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,5 +123,5 @@ resource "okta_email_customization" "forgot_password_es" {
Import is supported using the following syntax:

```shell
terraform import okta_email_customization.example &#60;customization_id&#62;/&#60;brand_id&#62;/&#60;template_name&#62;
terraform import okta_email_customization.example <customization_id>/<brand_id>/<template_name>
```
2 changes: 1 addition & 1 deletion docs/resources/email_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
terraform import okta_email_domain.example &#60;domain id&#62;
terraform import okta_email_domain.example <domain_id>
```
4 changes: 2 additions & 2 deletions docs/resources/email_sender.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
terraform import okta_email_sender.example &#60;sender id&#62;
```
terraform import okta_email_sender.example <sender_id>
```
2 changes: 1 addition & 1 deletion docs/resources/event_hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_event_hook.example &#60;hook id&#62;
terraform import okta_event_hook.example <hook_id>
```
2 changes: 1 addition & 1 deletion docs/resources/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ resource "okta_group" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_group.example &#60;group id&#62;
terraform import okta_group.example <group_id>
```
4 changes: 2 additions & 2 deletions docs/resources/group_memberships.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Import is supported using the following syntax:

```shell
# an Okta Group's memberships can be imported via the Okta group ID.
terraform import okta_group_memberships.test &#60;group id&#62;
terraform import okta_group_memberships.test <group_id>

# optional parameter track all users will also import all user id currently assigned to the group
terraform import okta_group_memberships.test &#60;group id&#62;/&#60;true&#62;
terraform import okta_group_memberships.test <group_id>/<true>
```
2 changes: 1 addition & 1 deletion docs/resources/group_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ resource "okta_group_role" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_group_role.example &#60;group id&#62;/&#60;role id&#62;
terraform import okta_group_role.example <group_id>/<role_id>
```
2 changes: 1 addition & 1 deletion docs/resources/group_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ resource "okta_group_rule" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_group_rule.example &#60;group rule id&#62;
terraform import okta_group_rule.example <group_rule_id>
```
2 changes: 1 addition & 1 deletion docs/resources/group_schema_property.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,5 +103,5 @@ Required:
Import is supported using the following syntax:

```shell
terraform import okta_group_schema_property.example &#60;index&#62;
terraform import okta_group_schema_property.example <index>
```
2 changes: 1 addition & 1 deletion docs/resources/idp_oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ resource "okta_idp_oidc" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_idp_oidc.example &#60;idp id&#62;
terraform import okta_idp_oidc.example <idp_id>
```
2 changes: 1 addition & 1 deletion docs/resources/idp_saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,5 @@ resource "okta_idp_saml" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_idp_saml.example &#60;idp id&#62;
terraform import okta_idp_saml.example <idp_id>
```
4 changes: 2 additions & 2 deletions docs/resources/idp_saml_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ resource "okta_idp_saml_key" "example_2" {
Import is supported using the following syntax:

```shell
terraform import okta_idp_saml_key.example &#60;key id&#62;
```
terraform import okta_idp_saml_key.example <key_id>
```
2 changes: 1 addition & 1 deletion docs/resources/idp_social.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,5 @@ resource "okta_idp_social" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_idp_social.example &#60;idp id&#62;
terraform import okta_idp_social.example <idp_id>
```
2 changes: 1 addition & 1 deletion docs/resources/inline_hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ Optional:
Import is supported using the following syntax:

```shell
terraform import okta_inline_hook.example &#60;hook id&#62;
terraform import okta_inline_hook.example <hook_id>
```
2 changes: 1 addition & 1 deletion docs/resources/link_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ resource "okta_link_definition" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_link_definition.example &#60;primary_name&#62;
terraform import okta_link_definition.example <primary_name>
```
2 changes: 1 addition & 1 deletion docs/resources/link_value.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ resource "okta_link_value" "example" {
Import is supported using the following syntax:

```shell
terraform import okta_link_value.example &#60;primary_name&#62;/&#60;primary_user_id&#62;
terraform import okta_link_value.example <primary_name>/<primary_user_id>
```
Loading

0 comments on commit a020024

Please sign in to comment.