Skip to content

Commit

Permalink
Terraform docs (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
ruvenzx authored Sep 23, 2024
1 parent 2818e41 commit 0d73d61
Show file tree
Hide file tree
Showing 13 changed files with 71 additions and 72 deletions.
4 changes: 2 additions & 2 deletions docs/raw/applications/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ oidc_applications

- Type: `list` of `applications.OIDC`

// description for oidc_applications
A list of `OIDC applications` type objects.



Expand All @@ -18,4 +18,4 @@ saml_applications

- Type: `list` of `applications.SAML`

// description for saml_applications
A list of `SAML applications` type applications.
14 changes: 7 additions & 7 deletions docs/raw/applications/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ id

- Type: `string`

// description for id
An identifier for the OIDC application.



Expand All @@ -18,7 +18,7 @@ name

- Type: `string` (required)

// description for name
A name for the OIDC application.



Expand All @@ -27,7 +27,7 @@ description

- Type: `string`

// description for description
A description for the OIDC application.



Expand All @@ -36,7 +36,7 @@ logo

- Type: `string`

// description for logo
A logo for the OIDC application. Should be a hosted image URL.



Expand All @@ -45,7 +45,7 @@ disabled

- Type: `bool`

// description for disabled
Whether the application should be enabled or disabled.



Expand All @@ -54,7 +54,7 @@ login_page_url

- Type: `string`

// description for login_page_url
The Flow Hosting URL. Read more about using this parameter with custom domain [here](https://docs.descope.com/sso-integrations/applications/saml-apps).



Expand All @@ -63,4 +63,4 @@ claims

- Type: `list` of `string`

// description for claims
A list of supported claims. e.g. `sub`, `email`, `exp`.
38 changes: 19 additions & 19 deletions docs/raw/applications/saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ id

- Type: `string`

// description for id
An identifier for the SAML application.



Expand All @@ -18,7 +18,7 @@ name

- Type: `string` (required)

// description for name
A name for the SAML application.



Expand All @@ -27,7 +27,7 @@ description

- Type: `string`

// description for description
A description for the SAML application.



Expand All @@ -36,7 +36,7 @@ logo

- Type: `string`

// description for logo
A logo for the SAML application. Should be a hosted image URL.



Expand All @@ -45,7 +45,7 @@ disabled

- Type: `bool`

// description for disabled
Whether the application should be enabled or disabled.



Expand All @@ -54,7 +54,7 @@ login_page_url

- Type: `string`

// description for login_page_url
The Flow Hosting URL. Read more about using this parameter with custom domain [here](https://docs.descope.com/sso-integrations/applications/saml-apps).



Expand All @@ -63,7 +63,7 @@ dynamic_configuration

- Type: `object` of `applications.DynamicConfiguration`

// description for dynamic_configuration
The `DynamicConfiguration` object. Read the description below.



Expand All @@ -72,7 +72,7 @@ manual_configuration

- Type: `object` of `applications.ManualConfiguration`

// description for manual_configuration
The `ManualConfiguration` object. Read the description below.



Expand All @@ -81,7 +81,7 @@ acs_allowed_callback_urls

- Type: `list` of `string`

// description for acs_allowed_callback_urls
A list of allowed ACS callback URLS. This configuration is used when the default ACS URL value is unreachable. Supports wildcards.



Expand All @@ -90,7 +90,7 @@ subject_name_id_type

- Type: `string`

// description for subject_name_id_type
The subject name id type. Choose one of "", "email", "phone". Read more about this configuration [here](https://docs.descope.com/sso-integrations/applications/saml-apps).



Expand All @@ -99,7 +99,7 @@ subject_name_id_format

- Type: `string`

// description for subject_name_id_format
The subject name id format. Choose one of "", "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", "urn:oasis:names:tc:SAML:2.0:nameid-format:transient". Read more about this configuration [here](https://docs.descope.com/sso-integrations/applications/saml-apps).



Expand All @@ -108,7 +108,7 @@ default_relay_state

- Type: `string`

// description for default_relay_state
The default relay state. When using IdP-initiated authentication, this value may be used as a URL to a resource in the Service Provider.



Expand All @@ -117,7 +117,7 @@ attribute_mapping

- Type: `list` of `applications.AttributeMapping`

// description for attribute_mapping
The `AttributeMapping` object. Read the description below.



Expand All @@ -133,7 +133,7 @@ name

- Type: `string` (required)

// description for name
The name of the attribute.



Expand All @@ -142,7 +142,7 @@ value

- Type: `string` (required)

// description for value
The value of the attribute.



Expand All @@ -158,7 +158,7 @@ metadata_url

- Type: `string` (required)

// description for metadata_url
The metadata URL when retrieving the connection details dynamically.



Expand All @@ -174,7 +174,7 @@ acs_url

- Type: `string` (required)

// description for acs_url
Enter the `ACS URL` from the SP.



Expand All @@ -183,7 +183,7 @@ entity_id

- Type: `string` (required)

// description for entity_id
Enter the `Entity Id` from the SP.



Expand All @@ -192,4 +192,4 @@ certificate

- Type: `string` (required)

// description for certificate
Enter the `Certificate` from the SP.
24 changes: 12 additions & 12 deletions docs/raw/attributes/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tenant

- Type: `list` of `attributes.TenantAttribute`

// description for tenant
A list of `TenantAttribute`. Read the description below.



Expand All @@ -18,7 +18,7 @@ user

- Type: `list` of `attributes.UserAttribute`

// description for user
A list of `UserAttribute`. Read the description below.



Expand All @@ -34,7 +34,7 @@ name

- Type: `string` (required)

// description for name
The name of the attribute.



Expand All @@ -43,7 +43,7 @@ type

- Type: `string` (required)

// description for type
The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".



Expand All @@ -52,7 +52,7 @@ select_options

- Type: `list` of `string`

// description for select_options
When the attribute type is "multiselect". A list of options to chose from.



Expand All @@ -68,7 +68,7 @@ name

- Type: `string` (required)

// description for name
The name of the attribute.



Expand All @@ -77,16 +77,16 @@ type

- Type: `string` (required)

// description for type
The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".



select_options
--------------

- Type: `list` of `string`

// description for select_options
When the attribute type is "multiselect". A list of options to chose from.



Expand All @@ -95,7 +95,7 @@ widget_authorization

- Type: `object` of `attributes.UserAttributeWidgetAuthorization`

// description for widget_authorization
The `UserAttributeWidgetAuthorization` object. Read the description below.



Expand All @@ -111,7 +111,7 @@ view_permissions

- Type: `list` of `string`

// description for view_permissions
A list of permissions by name to set viewing permissions to the attribute in widgets. e.g "SSO Admin".



Expand All @@ -120,4 +120,4 @@ edit_permissions

- Type: `list` of `string`

// description for edit_permissions
A list of permissions by name to set editing permissions to the attribute in widgets. e.g "SSO Admin".
4 changes: 2 additions & 2 deletions docs/raw/authorization/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ roles

- Type: `list` of `authorization.Role`

// description for roles
A list of `Role` objects.



Expand All @@ -18,4 +18,4 @@ permissions

- Type: `list` of `authorization.Permission`

// description for permissions
A list of `Permission` objects.
4 changes: 2 additions & 2 deletions docs/raw/authorization/permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ name

- Type: `string` (required)

// description for name
A name for the permission.



Expand All @@ -18,4 +18,4 @@ description

- Type: `string`

// description for description
A description for the permission.
9 changes: 4 additions & 5 deletions docs/raw/authorization/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,21 @@ name

- Type: `string` (required)

// description for name

A name for the role.


description
-----------

- Type: `string`

// description for description

A description for the role.


permissions
-----------

- Type: `list` of `string`

// description for permissions
A list of permissions by name to be included in the role.

Loading

0 comments on commit 0d73d61

Please sign in to comment.