okta.app.Saml

Custom error page URL.

Custom login page for this application.

Enable self-service. Default is: false.

AcsEndpoints List<string>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

AdminNote string

Application notes for admins.

AppLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

AppSettingsJson string

Application settings in JSON format.

AttributeStatements List<SamlAttributeStatementArgs>

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

Audience string

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

Display auto submit toolbar. Default is: false

Identifies a specific application resource in an IDP initiated SSO scenario.

Destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

DigestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

EnduserNote string

Application notes for end users.

Groups List<string>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

HideIos bool

Do not display application icon on mobile app. Default is: false

HideWeb bool

Do not display application icon to users. Default is: false

Prompt user to re-authenticate if SP asks for it. Default is: false

IdpIssuer string

SAML issuer ID.

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

InlineHookId string

Saml Inline Hook associated with the application.

KeyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

Number of years the certificate is valid (2 - 10 years).

Logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

Recipient string

The location where the app may present the SAML assertion.

Denotes whether the request is compressed or not.

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

SamlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

Signature algorithm used ot digitally sign the assertion and response.

x509 encoded certificate that the Service Provider uses to sign Single Logout requests. Note: should be provided without -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----, see official documentation.

The issuer of the Service Provider that generates the Single Logout request.

SingleLogoutUrl string

The location where the logout response is sent.

SkipGroups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

SpIssuer string

SAML service provider issuer.

SsoUrl string

Single Sign-on Url.

Status string

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

UserNameTemplate string

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

Users List<SamlUserArgs>

Username template type. Default is: "BUILT_IN".

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Label string

label of application.

Custom error page URL.

Custom login page for this application.

Enable self-service. Default is: false.

AcsEndpoints []string

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

AdminNote string

Application notes for admins.

AppLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

AppSettingsJson string

Application settings in JSON format.

AttributeStatements []SamlAttributeStatementArgs

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

Audience string

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

Display auto submit toolbar. Default is: false

Identifies a specific application resource in an IDP initiated SSO scenario.

Destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

DigestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

EnduserNote string

Application notes for end users.

Groups []string

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

HideIos bool

Do not display application icon on mobile app. Default is: false

HideWeb bool

Do not display application icon to users. Default is: false

Prompt user to re-authenticate if SP asks for it. Default is: false

IdpIssuer string

SAML issuer ID.

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

InlineHookId string

Saml Inline Hook associated with the application.

KeyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

Number of years the certificate is valid (2 - 10 years).

Logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

Recipient string

The location where the app may present the SAML assertion.

Denotes whether the request is compressed or not.

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

SamlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

SingleLogoutUrl string

The location where the logout response is sent.

SkipGroups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

SpIssuer string

SAML service provider issuer.

SsoUrl string

Single Sign-on Url.

Status string

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

UserNameTemplate string

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

Username template type. Default is: "BUILT_IN".

Users []SamlUserArgs

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label String

label of application.

Custom error page URL.

Custom login page for this application.

attributeStatements List<SamlAttributeStatementArgs>

Enable self-service. Default is: false.

acsEndpoints List<String>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote String

Application notes for admins.

appLinksJson String

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson String

Application settings in JSON format.

assertionSigned Boolean

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

audience String

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar Boolean

Display auto submit toolbar. Default is: false

Identifies a specific application resource in an IDP initiated SSO scenario.

destination String

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm String

Determines the digest algorithm used to digitally sign the SAML assertion and response

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos Boolean

Do not display application icon on mobile app. Default is: false

hideWeb Boolean

Do not display application icon to users. Default is: false

honorForceAuthn Boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

idpIssuer String

SAML issuer ID.

implicitAssignment Boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId String

Saml Inline Hook associated with the application.

keyName String

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid Integer

Number of years the certificate is valid (2 - 10 years).

logo String

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient String

The location where the app may present the SAML assertion.

requestCompressed Boolean

Denotes whether the request is compressed or not.

responseSigned Boolean

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

samlVersion String

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl String

The location where the logout response is sent.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer String

SAML service provider issuer.

ssoUrl String

Single Sign-on Url.

status String

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

userNameTemplate String

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

users List<SamlUserArgs>

Username template type. Default is: "BUILT_IN".

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label string

label of application.

accessibilityErrorRedirectUrl string

Custom error page URL.

accessibilityLoginRedirectUrl string

Custom login page for this application.

accessibilitySelfService boolean

Enable self-service. Default is: false.

acsEndpoints string[]

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote string

Application notes for admins.

appLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson string

Application settings in JSON format.

assertionSigned boolean

Determines whether the SAML assertion is digitally signed.

attributeStatements SamlAttributeStatementArgs[]

List of SAML Attribute statements.

audience string

Audience Restriction

authenticationPolicy string

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

authnContextClassRef string

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar boolean

Display auto submit toolbar. Default is: false

defaultRelayState string

Identifies a specific application resource in an IDP initiated SSO scenario.

destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

enduserNote string

Application notes for end users.

groups string[]

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos boolean

Do not display application icon on mobile app. Default is: false

hideWeb boolean

Do not display application icon to users. Default is: false

honorForceAuthn boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

idpIssuer string

SAML issuer ID.

implicitAssignment boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId string

Saml Inline Hook associated with the application.

keyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid number

Number of years the certificate is valid (2 - 10 years).

logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

preconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient string

The location where the app may present the SAML assertion.

requestCompressed boolean

Denotes whether the request is compressed or not.

responseSigned boolean

Determines whether the SAML auth response message is digitally signed.

samlSignedRequestEnabled boolean

SAML Signed Request enabled

samlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

signatureAlgorithm string

Signature algorithm used ot digitally sign the assertion and response.

singleLogoutCertificate string

singleLogoutIssuer string

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl string

The location where the logout response is sent.

skipGroups boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer string

SAML service provider issuer.

ssoUrl string

Single Sign-on Url.

status string

status of application.

subjectNameIdFormat string

Identifies the SAML processing rules.

subjectNameIdTemplate string

Template for app user's username when a user is assigned to the app.

userNameTemplate string

Username template. Default is: "${source.login}"

userNameTemplatePushStatus string

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

userNameTemplateSuffix string

Username template suffix.

userNameTemplateType string

Username template type. Default is: "BUILT_IN".

users SamlUserArgs[]

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label str

label of application.

accessibility_error_redirect_url str

Custom error page URL.

accessibility_login_redirect_url str

Custom login page for this application.

accessibility_self_service bool

Enable self-service. Default is: false.

acs_endpoints Sequence[str]

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

admin_note str

Application notes for admins.

app_links_json str

Displays specific appLinks for the app. The value for each application link should be boolean.

app_settings_json str

Application settings in JSON format.

assertion_signed bool

Determines whether the SAML assertion is digitally signed.

attribute_statements Sequence[SamlAttributeStatementArgs]

List of SAML Attribute statements.

audience str

Audience Restriction

authentication_policy str

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

authn_context_class_ref str

Identifies the SAML authentication context class for the assertion’s authentication statement

auto_submit_toolbar bool

Display auto submit toolbar. Default is: false

default_relay_state str

Identifies a specific application resource in an IDP initiated SSO scenario.

destination str

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digest_algorithm str

Determines the digest algorithm used to digitally sign the SAML assertion and response

enduser_note str

Application notes for end users.

groups Sequence[str]

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hide_ios bool

Do not display application icon on mobile app. Default is: false

hide_web bool

Do not display application icon to users. Default is: false

honor_force_authn bool

Prompt user to re-authenticate if SP asks for it. Default is: false

idp_issuer str

SAML issuer ID.

implicit_assignment bool

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inline_hook_id str

Saml Inline Hook associated with the application.

key_name str

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

key_years_valid int

Number of years the certificate is valid (2 - 10 years).

logo str

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

preconfigured_app str

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient str

The location where the app may present the SAML assertion.

request_compressed bool

Denotes whether the request is compressed or not.

response_signed bool

Determines whether the SAML auth response message is digitally signed.

saml_signed_request_enabled bool

SAML Signed Request enabled

saml_version str

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

signature_algorithm str

Signature algorithm used ot digitally sign the assertion and response.

single_logout_certificate str

single_logout_issuer str

The issuer of the Service Provider that generates the Single Logout request.

single_logout_url str

The location where the logout response is sent.

skip_groups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skip_users bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

sp_issuer str

SAML service provider issuer.

sso_url str

Single Sign-on Url.

status str

status of application.

subject_name_id_format str

Identifies the SAML processing rules.

subject_name_id_template str

Template for app user's username when a user is assigned to the app.

user_name_template str

Username template. Default is: "${source.login}"

user_name_template_push_status str

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

user_name_template_suffix str

Username template suffix.

user_name_template_type str

Username template type. Default is: "BUILT_IN".

users Sequence[SamlUserArgs]

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label String

label of application.

Custom error page URL.

Custom login page for this application.

attributeStatements List<Property Map>

Enable self-service. Default is: false.

acsEndpoints List<String>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote String

Application notes for admins.

appLinksJson String

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson String

Application settings in JSON format.

assertionSigned Boolean

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

audience String

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar Boolean

Display auto submit toolbar. Default is: false

Identifies a specific application resource in an IDP initiated SSO scenario.

destination String

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm String

Determines the digest algorithm used to digitally sign the SAML assertion and response

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos Boolean

Do not display application icon on mobile app. Default is: false

hideWeb Boolean

Do not display application icon to users. Default is: false

honorForceAuthn Boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

idpIssuer String

SAML issuer ID.

implicitAssignment Boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId String

Saml Inline Hook associated with the application.

keyName String

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid Number

Number of years the certificate is valid (2 - 10 years).

logo String

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient String

The location where the app may present the SAML assertion.

requestCompressed Boolean

Denotes whether the request is compressed or not.

responseSigned Boolean

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

samlVersion String

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl String

The location where the logout response is sent.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer String

SAML service provider issuer.

ssoUrl String

Single Sign-on Url.

status String

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

userNameTemplate String

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

users List<Property Map>

Username template type. Default is: "BUILT_IN".

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Outputs

All input properties are implicitly available as output properties. Additionally, the Saml resource produces the following output properties:

Certificate string: The raw signing certificate.
EmbedUrl string: Url that can be used to embed this application into another portal.
EntityKey string: Entity ID, the ID portion of the entity_url.
EntityUrl string: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
Features List<string>: features enabled. Notice: you can't currently configure provisioning features via the API.
HttpPostBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
HttpRedirectBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
Id string: The provider-assigned unique ID for this managed resource.
KeyId string: Certificate key ID.
Keys List<SamlKey>: An array of all key credentials for the application. Format of each entry is as follows:
LogoUrl string: Direct link of application logo.
Metadata string: The raw SAML metadata in XML.
MetadataUrl string: SAML xml metadata URL.
Name string: The name of the attribute statement.
SignOnMode string: Sign-on mode of application.

Certificate string: The raw signing certificate.
EmbedUrl string: Url that can be used to embed this application into another portal.
EntityKey string: Entity ID, the ID portion of the entity_url.
EntityUrl string: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
Features []string: features enabled. Notice: you can't currently configure provisioning features via the API.
HttpPostBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
HttpRedirectBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
Id string: The provider-assigned unique ID for this managed resource.
KeyId string: Certificate key ID.
Keys []SamlKey: An array of all key credentials for the application. Format of each entry is as follows:
LogoUrl string: Direct link of application logo.
Metadata string: The raw SAML metadata in XML.
MetadataUrl string: SAML xml metadata URL.
Name string: The name of the attribute statement.
SignOnMode string: Sign-on mode of application.

certificate String: The raw signing certificate.
embedUrl String: Url that can be used to embed this application into another portal.
entityKey String: Entity ID, the ID portion of the entity_url.
entityUrl String: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
features List<String>: features enabled. Notice: you can't currently configure provisioning features via the API.
httpPostBinding String: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
httpRedirectBinding String: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
id String: The provider-assigned unique ID for this managed resource.
keyId String: Certificate key ID.
keys List<SamlKey>: An array of all key credentials for the application. Format of each entry is as follows:
logoUrl String: Direct link of application logo.
metadata String: The raw SAML metadata in XML.
metadataUrl String: SAML xml metadata URL.
name String: The name of the attribute statement.
signOnMode String: Sign-on mode of application.

certificate string: The raw signing certificate.
embedUrl string: Url that can be used to embed this application into another portal.
entityKey string: Entity ID, the ID portion of the entity_url.
entityUrl string: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
features string[]: features enabled. Notice: you can't currently configure provisioning features via the API.
httpPostBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
httpRedirectBinding string: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
id string: The provider-assigned unique ID for this managed resource.
keyId string: Certificate key ID.
keys SamlKey[]: An array of all key credentials for the application. Format of each entry is as follows:
logoUrl string: Direct link of application logo.
metadata string: The raw SAML metadata in XML.
metadataUrl string: SAML xml metadata URL.
name string: The name of the attribute statement.
signOnMode string: Sign-on mode of application.

certificate str: The raw signing certificate.
embed_url str: Url that can be used to embed this application into another portal.
entity_key str: Entity ID, the ID portion of the entity_url.
entity_url str: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
features Sequence[str]: features enabled. Notice: you can't currently configure provisioning features via the API.
http_post_binding str: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
http_redirect_binding str: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
id str: The provider-assigned unique ID for this managed resource.
key_id str: Certificate key ID.
keys Sequence[SamlKey]: An array of all key credentials for the application. Format of each entry is as follows:
logo_url str: Direct link of application logo.
metadata str: The raw SAML metadata in XML.
metadata_url str: SAML xml metadata URL.
name str: The name of the attribute statement.
sign_on_mode str: Sign-on mode of application.

certificate String: The raw signing certificate.
embedUrl String: Url that can be used to embed this application into another portal.
entityKey String: Entity ID, the ID portion of the entity_url.
entityUrl String: Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.
features List<String>: features enabled. Notice: you can't currently configure provisioning features via the API.
httpPostBinding String: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.
httpRedirectBinding String: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.
id String: The provider-assigned unique ID for this managed resource.
keyId String: Certificate key ID.
keys List<Property Map>: An array of all key credentials for the application. Format of each entry is as follows:
logoUrl String: Direct link of application logo.
metadata String: The raw SAML metadata in XML.
metadataUrl String: SAML xml metadata URL.
name String: The name of the attribute statement.
signOnMode String: Sign-on mode of application.

Look up Existing Saml Resource

Get an existing Saml resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SamlState, opts?: CustomResourceOptions): Saml

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessibility_error_redirect_url: Optional[str] = None,
        accessibility_login_redirect_url: Optional[str] = None,
        accessibility_self_service: Optional[bool] = None,
        acs_endpoints: Optional[Sequence[str]] = None,
        admin_note: Optional[str] = None,
        app_links_json: Optional[str] = None,
        app_settings_json: Optional[str] = None,
        assertion_signed: Optional[bool] = None,
        attribute_statements: Optional[Sequence[SamlAttributeStatementArgs]] = None,
        audience: Optional[str] = None,
        authentication_policy: Optional[str] = None,
        authn_context_class_ref: Optional[str] = None,
        auto_submit_toolbar: Optional[bool] = None,
        certificate: Optional[str] = None,
        default_relay_state: Optional[str] = None,
        destination: Optional[str] = None,
        digest_algorithm: Optional[str] = None,
        embed_url: Optional[str] = None,
        enduser_note: Optional[str] = None,
        entity_key: Optional[str] = None,
        entity_url: Optional[str] = None,
        features: Optional[Sequence[str]] = None,
        groups: Optional[Sequence[str]] = None,
        hide_ios: Optional[bool] = None,
        hide_web: Optional[bool] = None,
        honor_force_authn: Optional[bool] = None,
        http_post_binding: Optional[str] = None,
        http_redirect_binding: Optional[str] = None,
        idp_issuer: Optional[str] = None,
        implicit_assignment: Optional[bool] = None,
        inline_hook_id: Optional[str] = None,
        key_id: Optional[str] = None,
        key_name: Optional[str] = None,
        key_years_valid: Optional[int] = None,
        keys: Optional[Sequence[SamlKeyArgs]] = None,
        label: Optional[str] = None,
        logo: Optional[str] = None,
        logo_url: Optional[str] = None,
        metadata: Optional[str] = None,
        metadata_url: Optional[str] = None,
        name: Optional[str] = None,
        preconfigured_app: Optional[str] = None,
        recipient: Optional[str] = None,
        request_compressed: Optional[bool] = None,
        response_signed: Optional[bool] = None,
        saml_signed_request_enabled: Optional[bool] = None,
        saml_version: Optional[str] = None,
        sign_on_mode: Optional[str] = None,
        signature_algorithm: Optional[str] = None,
        single_logout_certificate: Optional[str] = None,
        single_logout_issuer: Optional[str] = None,
        single_logout_url: Optional[str] = None,
        skip_groups: Optional[bool] = None,
        skip_users: Optional[bool] = None,
        sp_issuer: Optional[str] = None,
        sso_url: Optional[str] = None,
        status: Optional[str] = None,
        subject_name_id_format: Optional[str] = None,
        subject_name_id_template: Optional[str] = None,
        user_name_template: Optional[str] = None,
        user_name_template_push_status: Optional[str] = None,
        user_name_template_suffix: Optional[str] = None,
        user_name_template_type: Optional[str] = None,
        users: Optional[Sequence[SamlUserArgs]] = None) -> Saml

func GetSaml(ctx *Context, name string, id IDInput, state *SamlState, opts ...ResourceOption) (*Saml, error)

public static Saml Get(string name, Input<string> id, SamlState? state, CustomResourceOptions? opts = null)

public static Saml get(String name, Output<String> id, SamlState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Custom error page URL.

Custom login page for this application.

Enable self-service. Default is: false.

AcsEndpoints List<string>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

AdminNote string

Application notes for admins.

AppLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

AppSettingsJson string

Application settings in JSON format.

AttributeStatements List<SamlAttributeStatementArgs>

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

Audience string

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

Display auto submit toolbar. Default is: false

Certificate string

The raw signing certificate.

Identifies a specific application resource in an IDP initiated SSO scenario.

Destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

DigestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

EmbedUrl string

Url that can be used to embed this application into another portal.

EnduserNote string

Application notes for end users.

EntityKey string

Entity ID, the ID portion of the entity_url.

EntityUrl string

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

Features List<string>

features enabled. Notice: you can't currently configure provisioning features via the API.

Groups List<string>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

HideIos bool

Do not display application icon on mobile app. Default is: false

HideWeb bool

Do not display application icon to users. Default is: false

Prompt user to re-authenticate if SP asks for it. Default is: false

HttpPostBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

HttpRedirectBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

IdpIssuer string

SAML issuer ID.

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

InlineHookId string

Saml Inline Hook associated with the application.

KeyId string

Certificate key ID.

KeyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

Keys List<SamlKeyArgs>

Number of years the certificate is valid (2 - 10 years).

An array of all key credentials for the application. Format of each entry is as follows:

Label string

label of application.

Logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

LogoUrl string

Direct link of application logo.

Metadata string

The raw SAML metadata in XML.

MetadataUrl string

SAML xml metadata URL.

Name string

The name of the attribute statement.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

Recipient string

The location where the app may present the SAML assertion.

Denotes whether the request is compressed or not.

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

SamlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

SignOnMode string

Sign-on mode of application.

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

SingleLogoutUrl string

The location where the logout response is sent.

SkipGroups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

SpIssuer string

SAML service provider issuer.

SsoUrl string

Single Sign-on Url.

Status string

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

UserNameTemplate string

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

Users List<SamlUserArgs>

Username template type. Default is: "BUILT_IN".

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Custom error page URL.

Custom login page for this application.

Enable self-service. Default is: false.

AcsEndpoints []string

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

AdminNote string

Application notes for admins.

AppLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

AppSettingsJson string

Application settings in JSON format.

AttributeStatements []SamlAttributeStatementArgs

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

Audience string

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

Display auto submit toolbar. Default is: false

Certificate string

The raw signing certificate.

Identifies a specific application resource in an IDP initiated SSO scenario.

Destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

DigestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

EmbedUrl string

Url that can be used to embed this application into another portal.

EnduserNote string

Application notes for end users.

EntityKey string

Entity ID, the ID portion of the entity_url.

EntityUrl string

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

Features []string

features enabled. Notice: you can't currently configure provisioning features via the API.

Groups []string

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

HideIos bool

Do not display application icon on mobile app. Default is: false

HideWeb bool

Do not display application icon to users. Default is: false

Prompt user to re-authenticate if SP asks for it. Default is: false

HttpPostBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

HttpRedirectBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

IdpIssuer string

SAML issuer ID.

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

InlineHookId string

Saml Inline Hook associated with the application.

KeyId string

Certificate key ID.

KeyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

Number of years the certificate is valid (2 - 10 years).

Keys []SamlKeyArgs

An array of all key credentials for the application. Format of each entry is as follows:

Label string

label of application.

Logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

LogoUrl string

Direct link of application logo.

Metadata string

The raw SAML metadata in XML.

MetadataUrl string

SAML xml metadata URL.

Name string

The name of the attribute statement.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

Recipient string

The location where the app may present the SAML assertion.

Denotes whether the request is compressed or not.

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

SamlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

SignOnMode string

Sign-on mode of application.

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

SingleLogoutUrl string

The location where the logout response is sent.

SkipGroups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

SpIssuer string

SAML service provider issuer.

SsoUrl string

Single Sign-on Url.

Status string

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

UserNameTemplate string

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

Username template type. Default is: "BUILT_IN".

Users []SamlUserArgs

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Custom error page URL.

Custom login page for this application.

attributeStatements List<SamlAttributeStatementArgs>

Enable self-service. Default is: false.

acsEndpoints List<String>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote String

Application notes for admins.

appLinksJson String

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson String

Application settings in JSON format.

assertionSigned Boolean

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

audience String

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar Boolean

Display auto submit toolbar. Default is: false

certificate String

The raw signing certificate.

keys List<SamlKeyArgs>

Identifies a specific application resource in an IDP initiated SSO scenario.

destination String

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm String

Determines the digest algorithm used to digitally sign the SAML assertion and response

embedUrl String

Url that can be used to embed this application into another portal.

enduserNote String

Application notes for end users.

entityKey String

Entity ID, the ID portion of the entity_url.

entityUrl String

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

features List<String>

features enabled. Notice: you can't currently configure provisioning features via the API.

groups List<String>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos Boolean

Do not display application icon on mobile app. Default is: false

hideWeb Boolean

Do not display application icon to users. Default is: false

honorForceAuthn Boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

httpPostBinding String

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

httpRedirectBinding String

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

idpIssuer String

SAML issuer ID.

implicitAssignment Boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId String

Saml Inline Hook associated with the application.

keyId String

Certificate key ID.

keyName String

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid Integer

Number of years the certificate is valid (2 - 10 years).

An array of all key credentials for the application. Format of each entry is as follows:

label String

label of application.

logo String

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

logoUrl String

Direct link of application logo.

metadata String

The raw SAML metadata in XML.

metadataUrl String

SAML xml metadata URL.

name String

The name of the attribute statement.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient String

The location where the app may present the SAML assertion.

requestCompressed Boolean

Denotes whether the request is compressed or not.

responseSigned Boolean

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

samlVersion String

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

signOnMode String

Sign-on mode of application.

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl String

The location where the logout response is sent.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer String

SAML service provider issuer.

ssoUrl String

Single Sign-on Url.

status String

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

userNameTemplate String

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.

users List<SamlUserArgs>

Username template type. Default is: "BUILT_IN".

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

accessibilityErrorRedirectUrl string

Custom error page URL.

accessibilityLoginRedirectUrl string

Custom login page for this application.

accessibilitySelfService boolean

Enable self-service. Default is: false.

acsEndpoints string[]

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote string

Application notes for admins.

appLinksJson string

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson string

Application settings in JSON format.

assertionSigned boolean

Determines whether the SAML assertion is digitally signed.

attributeStatements SamlAttributeStatementArgs[]

List of SAML Attribute statements.

audience string

Audience Restriction

authenticationPolicy string

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

authnContextClassRef string

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar boolean

Display auto submit toolbar. Default is: false

certificate string

The raw signing certificate.

defaultRelayState string

Identifies a specific application resource in an IDP initiated SSO scenario.

destination string

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm string

Determines the digest algorithm used to digitally sign the SAML assertion and response

embedUrl string

Url that can be used to embed this application into another portal.

enduserNote string

Application notes for end users.

entityKey string

Entity ID, the ID portion of the entity_url.

entityUrl string

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

features string[]

features enabled. Notice: you can't currently configure provisioning features via the API.

groups string[]

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos boolean

Do not display application icon on mobile app. Default is: false

hideWeb boolean

Do not display application icon to users. Default is: false

honorForceAuthn boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

httpPostBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

httpRedirectBinding string

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

idpIssuer string

SAML issuer ID.

implicitAssignment boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId string

Saml Inline Hook associated with the application.

keyId string

Certificate key ID.

keyName string

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid number

Number of years the certificate is valid (2 - 10 years).

keys SamlKeyArgs[]

An array of all key credentials for the application. Format of each entry is as follows:

label string

label of application.

logo string

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

logoUrl string

Direct link of application logo.

metadata string

The raw SAML metadata in XML.

metadataUrl string

SAML xml metadata URL.

name string

The name of the attribute statement.

preconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient string

The location where the app may present the SAML assertion.

requestCompressed boolean

Denotes whether the request is compressed or not.

responseSigned boolean

Determines whether the SAML auth response message is digitally signed.

samlSignedRequestEnabled boolean

SAML Signed Request enabled

samlVersion string

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

signOnMode string

Sign-on mode of application.

signatureAlgorithm string

Signature algorithm used ot digitally sign the assertion and response.

singleLogoutCertificate string

singleLogoutIssuer string

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl string

The location where the logout response is sent.

skipGroups boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer string

SAML service provider issuer.

ssoUrl string

Single Sign-on Url.

status string

status of application.

subjectNameIdFormat string

Identifies the SAML processing rules.

subjectNameIdTemplate string

Template for app user's username when a user is assigned to the app.

userNameTemplate string

Username template. Default is: "${source.login}"

userNameTemplatePushStatus string

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

userNameTemplateSuffix string

Username template suffix.

userNameTemplateType string

Username template type. Default is: "BUILT_IN".

users SamlUserArgs[]

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

accessibility_error_redirect_url str

Custom error page URL.

accessibility_login_redirect_url str

Custom login page for this application.

accessibility_self_service bool

Enable self-service. Default is: false.

acs_endpoints Sequence[str]

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

admin_note str

Application notes for admins.

app_links_json str

Displays specific appLinks for the app. The value for each application link should be boolean.

app_settings_json str

Application settings in JSON format.

assertion_signed bool

Determines whether the SAML assertion is digitally signed.

attribute_statements Sequence[SamlAttributeStatementArgs]

List of SAML Attribute statements.

audience str

Audience Restriction

authentication_policy str

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

authn_context_class_ref str

Identifies the SAML authentication context class for the assertion’s authentication statement

auto_submit_toolbar bool

Display auto submit toolbar. Default is: false

certificate str

The raw signing certificate.

default_relay_state str

Identifies a specific application resource in an IDP initiated SSO scenario.

destination str

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digest_algorithm str

Determines the digest algorithm used to digitally sign the SAML assertion and response

embed_url str

Url that can be used to embed this application into another portal.

enduser_note str

Application notes for end users.

entity_key str

Entity ID, the ID portion of the entity_url.

entity_url str

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

features Sequence[str]

features enabled. Notice: you can't currently configure provisioning features via the API.

groups Sequence[str]

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hide_ios bool

Do not display application icon on mobile app. Default is: false

hide_web bool

Do not display application icon to users. Default is: false

honor_force_authn bool

Prompt user to re-authenticate if SP asks for it. Default is: false

http_post_binding str

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

http_redirect_binding str

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

idp_issuer str

SAML issuer ID.

implicit_assignment bool

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inline_hook_id str

Saml Inline Hook associated with the application.

key_id str

Certificate key ID.

key_name str

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

key_years_valid int

Number of years the certificate is valid (2 - 10 years).

keys Sequence[SamlKeyArgs]

An array of all key credentials for the application. Format of each entry is as follows:

label str

label of application.

logo str

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

logo_url str

Direct link of application logo.

metadata str

The raw SAML metadata in XML.

metadata_url str

SAML xml metadata URL.

name str

The name of the attribute statement.

preconfigured_app str

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient str

The location where the app may present the SAML assertion.

request_compressed bool

Denotes whether the request is compressed or not.

response_signed bool

Determines whether the SAML auth response message is digitally signed.

saml_signed_request_enabled bool

SAML Signed Request enabled

saml_version str

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

sign_on_mode str

Sign-on mode of application.

signature_algorithm str

Signature algorithm used ot digitally sign the assertion and response.

single_logout_certificate str

single_logout_issuer str

The issuer of the Service Provider that generates the Single Logout request.

single_logout_url str

The location where the logout response is sent.

skip_groups bool

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skip_users bool

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

sp_issuer str

SAML service provider issuer.

sso_url str

Single Sign-on Url.

status str

status of application.

subject_name_id_format str

Identifies the SAML processing rules.

subject_name_id_template str

Template for app user's username when a user is assigned to the app.

user_name_template str

Username template. Default is: "${source.login}"

user_name_template_push_status str

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

user_name_template_suffix str

Username template suffix.

user_name_template_type str

Username template type. Default is: "BUILT_IN".

users Sequence[SamlUserArgs]

Users associated with the application.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Custom error page URL.

Custom login page for this application.

attributeStatements List<Property Map>

Enable self-service. Default is: false.

acsEndpoints List<String>

An array of ACS endpoints. You can configure a maximum of 100 endpoints.

adminNote String

Application notes for admins.

appLinksJson String

Displays specific appLinks for the app. The value for each application link should be boolean.

appSettingsJson String

Application settings in JSON format.

assertionSigned Boolean

Determines whether the SAML assertion is digitally signed.

List of SAML Attribute statements.

audience String

Audience Restriction

The ID of the associated app_signon_policy. If this property is removed from the application the default sign-on-policy will be associated with this application.

Identifies the SAML authentication context class for the assertion’s authentication statement

autoSubmitToolbar Boolean

Display auto submit toolbar. Default is: false

certificate String

The raw signing certificate.

keys List<Property Map>

Identifies a specific application resource in an IDP initiated SSO scenario.

destination String

Identifies the location where the SAML response is intended to be sent inside of the SAML assertion

digestAlgorithm String

Determines the digest algorithm used to digitally sign the SAML assertion and response

embedUrl String

Url that can be used to embed this application into another portal.

enduserNote String

Application notes for end users.

entityKey String

Entity ID, the ID portion of the entity_url.

entityUrl String

Entity URL for instance http://www.okta.com/exk1fcia6d6EMsf331d8.

features List<String>

features enabled. Notice: you can't currently configure provisioning features via the API.

groups List<String>

Groups associated with the application.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

hideIos Boolean

Do not display application icon on mobile app. Default is: false

hideWeb Boolean

Do not display application icon to users. Default is: false

honorForceAuthn Boolean

Prompt user to re-authenticate if SP asks for it. Default is: false

httpPostBinding String

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Post location from the SAML metadata.

httpRedirectBinding String

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect location from the SAML metadata.

idpIssuer String

SAML issuer ID.

implicitAssignment Boolean

Early Access Property. Enables Federation Broker Mode. When this mode is enabled, users and groups arguments are ignored.

inlineHookId String

Saml Inline Hook associated with the application.

keyId String

Certificate key ID.

keyName String

Certificate name. This modulates the rotation of keys. New name == new key. Required to be set with key_years_valid.

keyYearsValid Number

Number of years the certificate is valid (2 - 10 years).

An array of all key credentials for the application. Format of each entry is as follows:

label String

label of application.

logo String

Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

logoUrl String

Direct link of application logo.

metadata String

The raw SAML metadata in XML.

metadataUrl String

SAML xml metadata URL.

name String

The name of the attribute statement.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created. If not provided the following arguments are required:

recipient String

The location where the app may present the SAML assertion.

requestCompressed Boolean

Denotes whether the request is compressed or not.

responseSigned Boolean

Determines whether the SAML auth response message is digitally signed.

SAML Signed Request enabled

samlVersion String

SAML version for the app's sign-on mode. Valid values are: "2.0" or "1.1". Default is "2.0".

signOnMode String

Sign-on mode of application.

Signature algorithm used ot digitally sign the assertion and response.

The issuer of the Service Provider that generates the Single Logout request.

singleLogoutUrl String

The location where the logout response is sent.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it can also be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it can also be provided during import). Default is false.

spIssuer String

SAML service provider issuer.

ssoUrl String

Single Sign-on Url.

status String

status of application.

Identifies the SAML processing rules.

Template for app user's username when a user is assigned to the app.

userNameTemplate String

Username template. Default is: "${source.login}"

Push username on update. Valid values: "PUSH" and "DONT_PUSH".

Username template suffix.