GetSaml

Use this data source to retrieve the collaborators for a given repository.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Okta.App.GetSaml.InvokeAsync(new Okta.App.GetSamlArgs
        {
            Label = "Example App",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.app.get_saml(label="Example App")

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = pulumi.output(okta.app.getSaml({
    label: "Example App",
}, { async: true }));

Using GetSaml

function getSaml(args: GetSamlArgs, opts?: InvokeOptions): Promise<GetSamlResult>

function  get_saml(accessibility_error_redirect_url=None, accessibility_login_redirect_url=None, accessibility_self_service=None, active_only=None, app_settings_json=None, assertion_signed=None, attribute_statements=None, audience=None, authn_context_class_ref=None, auto_submit_toolbar=None, default_relay_state=None, destination=None, digest_algorithm=None, features=None, hide_ios=None, hide_web=None, honor_force_authn=None, id=None, idp_issuer=None, label=None, label_prefix=None, recipient=None, request_compressed=None, response_signed=None, signature_algorithm=None, sp_issuer=None, sso_url=None, subject_name_id_format=None, subject_name_id_template=None, user_name_template=None, user_name_template_suffix=None, user_name_template_type=None, opts=None)

func LookupSaml(ctx *Context, args *LookupSamlArgs, opts ...InvokeOption) (*LookupSamlResult, error)

Note: This function is named LookupSaml in the Go SDK.

public static class GetSaml {
    public static Task<GetSamlResult> InvokeAsync(GetSamlArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AccessibilityErrorRedirectUrl string: Custom error page URL.
AccessibilityLoginRedirectUrl string: Custom login page URL.
AccessibilitySelfService bool: Enable self service.
ActiveOnly bool: tells the provider to query for only ACTIVE applications.
AppSettingsJson string: Application settings in JSON format.
AssertionSigned bool: Determines whether the SAML assertion is digitally signed.
AttributeStatements List<GetSamlAttributeStatementArgs>: SAML Attribute statements.
Audience string: Audience restriction.
AuthnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
AutoSubmitToolbar bool: Display auto submit toolbar.
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.
Features List<string>: features enabled.
HideIos bool: Do not display application icon on mobile app.
HideWeb bool: Do not display application icon to users
HonorForceAuthn bool: Prompt user to re-authenticate if SP asks for it.
Id string: id of application to retrieve, conflicts with label and label_prefix.
IdpIssuer string: SAML issuer ID.
Label string: The label of the app to retrieve, conflicts with label_prefix and id.
LabelPrefix string: Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.
Recipient string: The location where the app may present the SAML assertion.
RequestCompressed bool: Denotes whether the request is compressed or not.
ResponseSigned bool: Determines whether the SAML auth response message is digitally signed.
SignatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
SpIssuer string: SAML service provider issuer.
SsoUrl string: Single Sign on Url.
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.
UserNameTemplateSuffix string: Username template suffix.
UserNameTemplateType string: Username template type.

AccessibilityErrorRedirectUrl string: Custom error page URL.
AccessibilityLoginRedirectUrl string: Custom login page URL.
AccessibilitySelfService bool: Enable self service.
ActiveOnly bool: tells the provider to query for only ACTIVE applications.
AppSettingsJson string: Application settings in JSON format.
AssertionSigned bool: Determines whether the SAML assertion is digitally signed.
AttributeStatements []GetSamlAttributeStatement: SAML Attribute statements.
Audience string: Audience restriction.
AuthnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
AutoSubmitToolbar bool: Display auto submit toolbar.
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.
Features []string: features enabled.
HideIos bool: Do not display application icon on mobile app.
HideWeb bool: Do not display application icon to users
HonorForceAuthn bool: Prompt user to re-authenticate if SP asks for it.
Id string: id of application to retrieve, conflicts with label and label_prefix.
IdpIssuer string: SAML issuer ID.
Label string: The label of the app to retrieve, conflicts with label_prefix and id.
LabelPrefix string: Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.
Recipient string: The location where the app may present the SAML assertion.
RequestCompressed bool: Denotes whether the request is compressed or not.
ResponseSigned bool: Determines whether the SAML auth response message is digitally signed.
SignatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
SpIssuer string: SAML service provider issuer.
SsoUrl string: Single Sign on Url.
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.
UserNameTemplateSuffix string: Username template suffix.
UserNameTemplateType string: Username template type.

accessibilityErrorRedirectUrl string: Custom error page URL.
accessibilityLoginRedirectUrl string: Custom login page URL.
accessibilitySelfService boolean: Enable self service.
activeOnly boolean: tells the provider to query for only ACTIVE applications.
appSettingsJson string: Application settings in JSON format.
assertionSigned boolean: Determines whether the SAML assertion is digitally signed.
attributeStatements GetSamlAttributeStatement[]: SAML Attribute statements.
audience string: Audience restriction.
authnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
autoSubmitToolbar boolean: Display auto submit toolbar.
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.
features string[]: features enabled.
hideIos boolean: Do not display application icon on mobile app.
hideWeb boolean: Do not display application icon to users
honorForceAuthn boolean: Prompt user to re-authenticate if SP asks for it.
id string: id of application to retrieve, conflicts with label and label_prefix.
idpIssuer string: SAML issuer ID.
label string: The label of the app to retrieve, conflicts with label_prefix and id.
labelPrefix string: Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.
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.
signatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
spIssuer string: SAML service provider issuer.
ssoUrl string: Single Sign on Url.
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.
userNameTemplateSuffix string: Username template suffix.
userNameTemplateType string: Username template type.

accessibility_error_redirect_url str: Custom error page URL.
accessibility_login_redirect_url str: Custom login page URL.
accessibility_self_service bool: Enable self service.
active_only bool: tells the provider to query for only ACTIVE applications.
app_settings_json str: Application settings in JSON format.
assertion_signed bool: Determines whether the SAML assertion is digitally signed.
attribute_statements List[GetSamlAttributeStatement]: SAML Attribute statements.
audience str: Audience restriction.
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_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.
features List[str]: features enabled.
hide_ios bool: Do not display application icon on mobile app.
hide_web bool: Do not display application icon to users
honor_force_authn bool: Prompt user to re-authenticate if SP asks for it.
id str: id of application to retrieve, conflicts with label and label_prefix.
idp_issuer str: SAML issuer ID.
label str: The label of the app to retrieve, conflicts with label_prefix and id.
label_prefix str: Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.
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.
signature_algorithm str: Signature algorithm used ot digitally sign the assertion and response.
sp_issuer str: SAML service provider issuer.
sso_url str: Single Sign on Url.
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.
user_name_template_suffix str: Username template suffix.
user_name_template_type str: Username template type.

GetSaml Result

The following output properties are available:

Description string: description of application.
KeyId string: Certificate key ID.
Name string: name of application.
Status string: status of application.
AccessibilityErrorRedirectUrl string: Custom error page URL.
AccessibilityLoginRedirectUrl string: Custom login page URL.
AccessibilitySelfService bool: Enable self service.
ActiveOnly bool
AppSettingsJson string: Application settings in JSON format.
AssertionSigned bool: Determines whether the SAML assertion is digitally signed.
AttributeStatements List<GetSamlAttributeStatement>: SAML Attribute statements.
Audience string: Audience restriction.
AuthnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
AutoSubmitToolbar bool: Display auto submit toolbar.
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.
Features List<string>: features enabled.
HideIos bool: Do not display application icon on mobile app.
HideWeb bool: Do not display application icon to users
HonorForceAuthn bool: Prompt user to re-authenticate if SP asks for it.
Id string: id of application.
IdpIssuer string: SAML issuer ID.
Label string: label of application.
LabelPrefix string
Recipient string: The location where the app may present the SAML assertion.
RequestCompressed bool: Denotes whether the request is compressed or not.
ResponseSigned bool: Determines whether the SAML auth response message is digitally signed.
SignatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
SpIssuer string: SAML service provider issuer.
SsoUrl string: Single Sign on Url.
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.
UserNameTemplateSuffix string: Username template suffix.
UserNameTemplateType string: Username template type.

Description string: description of application.
KeyId string: Certificate key ID.
Name string: name of application.
Status string: status of application.
AccessibilityErrorRedirectUrl string: Custom error page URL.
AccessibilityLoginRedirectUrl string: Custom login page URL.
AccessibilitySelfService bool: Enable self service.
ActiveOnly bool
AppSettingsJson string: Application settings in JSON format.
AssertionSigned bool: Determines whether the SAML assertion is digitally signed.
AttributeStatements []GetSamlAttributeStatement: SAML Attribute statements.
Audience string: Audience restriction.
AuthnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
AutoSubmitToolbar bool: Display auto submit toolbar.
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.
Features []string: features enabled.
HideIos bool: Do not display application icon on mobile app.
HideWeb bool: Do not display application icon to users
HonorForceAuthn bool: Prompt user to re-authenticate if SP asks for it.
Id string: id of application.
IdpIssuer string: SAML issuer ID.
Label string: label of application.
LabelPrefix string
Recipient string: The location where the app may present the SAML assertion.
RequestCompressed bool: Denotes whether the request is compressed or not.
ResponseSigned bool: Determines whether the SAML auth response message is digitally signed.
SignatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
SpIssuer string: SAML service provider issuer.
SsoUrl string: Single Sign on Url.
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.
UserNameTemplateSuffix string: Username template suffix.
UserNameTemplateType string: Username template type.

description string: description of application.
keyId string: Certificate key ID.
name string: name of application.
status string: status of application.
accessibilityErrorRedirectUrl string: Custom error page URL.
accessibilityLoginRedirectUrl string: Custom login page URL.
accessibilitySelfService boolean: Enable self service.
activeOnly boolean
appSettingsJson string: Application settings in JSON format.
assertionSigned boolean: Determines whether the SAML assertion is digitally signed.
attributeStatements GetSamlAttributeStatement[]: SAML Attribute statements.
audience string: Audience restriction.
authnContextClassRef string: Identifies the SAML authentication context class for the assertion’s authentication statement.
autoSubmitToolbar boolean: Display auto submit toolbar.
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.
features string[]: features enabled.
hideIos boolean: Do not display application icon on mobile app.
hideWeb boolean: Do not display application icon to users
honorForceAuthn boolean: Prompt user to re-authenticate if SP asks for it.
id string: id of application.
idpIssuer string: SAML issuer ID.
label string: label of application.
labelPrefix string
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.
signatureAlgorithm string: Signature algorithm used ot digitally sign the assertion and response.
spIssuer string: SAML service provider issuer.
ssoUrl string: Single Sign on Url.
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.
userNameTemplateSuffix string: Username template suffix.
userNameTemplateType string: Username template type.

description str: description of application.
key_id str: Certificate key ID.
name str: name of application.
status str: status of application.
accessibility_error_redirect_url str: Custom error page URL.
accessibility_login_redirect_url str: Custom login page URL.
accessibility_self_service bool: Enable self service.
active_only bool
app_settings_json str: Application settings in JSON format.
assertion_signed bool: Determines whether the SAML assertion is digitally signed.
attribute_statements List[GetSamlAttributeStatement]: SAML Attribute statements.
audience str: Audience restriction.
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_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.
features List[str]: features enabled.
hide_ios bool: Do not display application icon on mobile app.
hide_web bool: Do not display application icon to users
honor_force_authn bool: Prompt user to re-authenticate if SP asks for it.
id str: id of application.
idp_issuer str: SAML issuer ID.
label str: label of application.
label_prefix str
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.
signature_algorithm str: Signature algorithm used ot digitally sign the assertion and response.
sp_issuer str: SAML service provider issuer.
sso_url str: Single Sign on Url.
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.
user_name_template_suffix str: Username template suffix.
user_name_template_type str: Username template type.

Supporting Types

GetSamlAttributeStatement

See the input and output API doc for this type.

Name string: name of application.
FilterType string
FilterValue string
Namespace string
Type string
Values List<string>

Name string: name of application.
FilterType string
FilterValue string
Namespace string
Type string
Values []string

name string: name of application.
filterType string
filterValue string
namespace string
type string
values string[]

name str: name of application.
filterType str
filterValue str
namespace str
type str
values List[str]

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetSaml

Example Usage

Using GetSaml

GetSaml Result

Supporting Types

GetSamlAttributeStatement

Package Details

On This Page