Class SamlUrlBuilder

Namespace

Auth0.AuthenticationApi.Builders

Assembly

Auth0.AuthenticationApi.dll

Builder class used to fluently construct a SAML authorization URL.

public class SamlUrlBuilder : UrlBuilderBase<SamlUrlBuilder>

Inheritance

object

UrlBuilderBase<SamlUrlBuilder>

SamlUrlBuilder

Inherited Members

UrlBuilderBase<SamlUrlBuilder>.AddUrlSegment(string, string)

UrlBuilderBase<SamlUrlBuilder>.AddQueryString(string, string)

UrlBuilderBase<SamlUrlBuilder>.WithValue(string, string)

UrlBuilderBase<SamlUrlBuilder>.Build()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

See https://auth0.com/docs/api/authentication#accept-request for more details.

Constructors

SamlUrlBuilder(string, string)

Initializes a new instance of the SamlUrlBuilder class.

public SamlUrlBuilder(string baseUrl, string clientId)

Parameters

baseUrl string

Base URL of the Authentication API represented as a string.

clientId string

Client ID of the application.

SamlUrlBuilder(Uri, string)

Initializes a new instance of the SamlUrlBuilder class.

public SamlUrlBuilder(Uri baseUrl, string clientId)

Parameters

baseUrl Uri

Base URL of the Authentication API represented as a Uri.

clientId string

Client ID of the application.

Methods

WithConnection(string)

Adds the connection query string parameter specifying the connection name.

public SamlUrlBuilder WithConnection(string connectionName)

Parameters

connectionName string

Name of the connection.

Returns

SamlUrlBuilder

Current SamlUrlBuilder to allow fluent configuration.

WithRelayState(IDictionary<string, string>)

Adds the RelayState query string parameter.

public SamlUrlBuilder WithRelayState(IDictionary<string, string> values)

Parameters

values IDictionary<string, string>

Dictionary containing key-value pairs for the RelayState parameter.

Returns

SamlUrlBuilder

Current SamlUrlBuilder to allow fluent configuration.

Remarks

See https://auth0.com/docs/protocols/saml/saml-configuration/special-configuration-scenarios/idp-initiated-sso#auth0-as-identity-provider-where-idp-initiates-sso for more details on RelayState.

WithRelayState(string)

Adds the RelayState query string parameter.

public SamlUrlBuilder WithRelayState(string value)

Parameters

value string

Value of RelayState parameter in key-value format, e.g.

xcrf=abc&ru=/foo

.

Returns

SamlUrlBuilder

Current SamlUrlBuilder to allow fluent configuration.

Remarks

See https://auth0.com/docs/protocols/saml/saml-configuration/special-configuration-scenarios/idp-initiated-sso#auth0-as-identity-provider-where-idp-initiates-sso for more details on RelayState.