Class WsFedUrlBuilder

Namespace

Auth0.AuthenticationApi.Builders

Assembly

Auth0.AuthenticationApi.dll

Builder class used to fluently construct a WS-Federation authorization URL.

public class WsFedUrlBuilder : UrlBuilderBase<WsFedUrlBuilder>

Inheritance

object

UrlBuilderBase<WsFedUrlBuilder>

WsFedUrlBuilder

Inherited Members

UrlBuilderBase<WsFedUrlBuilder>.AddUrlSegment(string, string)

UrlBuilderBase<WsFedUrlBuilder>.AddQueryString(string, string)

UrlBuilderBase<WsFedUrlBuilder>.WithValue(string, string)

UrlBuilderBase<WsFedUrlBuilder>.Build()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WsFedUrlBuilder(string, string)

Initializes a new instance of the WsFedUrlBuilder class.

public WsFedUrlBuilder(string baseUrl, string clientId = null)

Parameters

baseUrl string

Base URL of the Authentication API represented as a string.

clientId string

Optional Client ID of the application.

WsFedUrlBuilder(Uri, string)

Initializes a new instance of the WsFedUrlBuilder class.

public WsFedUrlBuilder(Uri baseUrl, string clientId = null)

Parameters

baseUrl Uri

Base URL of the Authentication API represented as a Uri.

clientId string

Optional Client ID of the application.

Methods

WithClient(string)

Adds the client URL segment specifying the Client ID of the application.

public WsFedUrlBuilder WithClient(string clientId)

Parameters

clientId string

Client ID of the application.

Returns

WsFedUrlBuilder

Current WsFedUrlBuilder to allow fluent configuration.

WithWctx(IDictionary<string, string>)

Adds the wctx query string parameter.

public WsFedUrlBuilder WithWctx(IDictionary<string, string> values)

Parameters

values IDictionary<string, string>

Dictionary containing the key-value pairs of the wctx parameter.

Returns

WsFedUrlBuilder

Current WsFedUrlBuilder to allow fluent configuration.

WithWctx(string)

Adds the wctx query string parameter.

public WsFedUrlBuilder WithWctx(string value)

Parameters

value string

Value of the wctx parameter in key-value pair format, e.g.

xcrf=abc&ru=/foo

.

Returns

WsFedUrlBuilder

Current WsFedUrlBuilder to allow fluent configuration.

WithWhr(string)

Adds the whr query string parameter.

public WsFedUrlBuilder WithWhr(string value)

Parameters

value string

Value of the whr parameter.

Returns

WsFedUrlBuilder

Current WsFedUrlBuilder to allow fluent configuration.

WithWtrealm(string)

Adds the wtrealm query string parameter.

public WsFedUrlBuilder WithWtrealm(string value)

Parameters

value string

Value of the wtrealm query string parameter.

Returns

WsFedUrlBuilder

Current WsFedUrlBuilder to allow fluent configuration.