RequestParameterBuilder module
Functions
Function Details
addApplicationTelemetry(Map<string, string>, ApplicationTelemetry)
Add client telemetry parameters
function addApplicationTelemetry(parameters: Map<string, string>, appTelemetry: ApplicationTelemetry)Parameters
- parameters
-
Map<string, string>
- appTelemetry
- ApplicationTelemetry
addAuthorizationCode(Map<string, string>, string)
add the authorization_code passed by the user to exchange for a token
function addAuthorizationCode(parameters: Map<string, string>, code: string)Parameters
- parameters
-
Map<string, string>
- code
-
string
addBrokerParameters(Map<string, string>, string, string)
function addBrokerParameters(parameters: Map<string, string>, brokerClientId: string, brokerRedirectUri: string)Parameters
- parameters
-
Map<string, string>
- brokerClientId
-
string
- brokerRedirectUri
-
string
addCcsOid(Map<string, string>, ClientInfo)
Adds the CCS (Cache Credential Service) query parameter for account object
function addCcsOid(parameters: Map<string, string>, clientInfo: ClientInfo)Parameters
- parameters
-
Map<string, string>
- clientInfo
- ClientInfo
addCcsUpn(Map<string, string>, string)
Adds the CCS (Cache Credential Service) query parameter for login_hint
function addCcsUpn(parameters: Map<string, string>, loginHint: string)Parameters
- parameters
-
Map<string, string>
- loginHint
-
string
addClaims(Map<string, string>, string, string[])
add claims
function addClaims(parameters: Map<string, string>, claims?: string, clientCapabilities?: string[])Parameters
- parameters
-
Map<string, string>
- claims
-
string
- clientCapabilities
-
string[]
addCliData(Map<string, string>)
add clidata=1 to request to indicate client data support
function addCliData(parameters: Map<string, string>)Parameters
- parameters
-
Map<string, string>
addClientAssertion(Map<string, string>, string)
add clientAssertion for confidential client flows
function addClientAssertion(parameters: Map<string, string>, clientAssertion: string)Parameters
- parameters
-
Map<string, string>
- clientAssertion
-
string
addClientAssertionType(Map<string, string>, string)
add clientAssertionType for confidential client flows
function addClientAssertionType(parameters: Map<string, string>, clientAssertionType: string)Parameters
- parameters
-
Map<string, string>
- clientAssertionType
-
string
addClientCapabilitiesToClaims(string, string[])
function addClientCapabilitiesToClaims(claims?: string, clientCapabilities?: string[]): stringParameters
- claims
-
string
- clientCapabilities
-
string[]
Returns
string
addClientId(Map<string, string>, string)
add clientId
function addClientId(parameters: Map<string, string>, clientId: string)Parameters
- parameters
-
Map<string, string>
- clientId
-
string
addClientInfo(Map<string, string>)
add client info
function addClientInfo(parameters: Map<string, string>)Parameters
- parameters
-
Map<string, string>
addClientSecret(Map<string, string>, string)
add client_secret
function addClientSecret(parameters: Map<string, string>, clientSecret: string)Parameters
- parameters
-
Map<string, string>
- clientSecret
-
string
addCodeChallengeParams(Map<string, string>, string, string)
add code_challenge and code_challenge_method
- throw if either of them are not passed
function addCodeChallengeParams(parameters: Map<string, string>, codeChallenge?: string, codeChallengeMethod?: string)Parameters
- parameters
-
Map<string, string>
- codeChallenge
-
string
- codeChallengeMethod
-
string
addCodeVerifier(Map<string, string>, string)
add the code_verifier passed by the user to exchange for a token
function addCodeVerifier(parameters: Map<string, string>, codeVerifier: string)Parameters
- parameters
-
Map<string, string>
- codeVerifier
-
string
addCorrelationId(Map<string, string>, string)
add correlationId
function addCorrelationId(parameters: Map<string, string>, correlationId: string)Parameters
- parameters
-
Map<string, string>
- correlationId
-
string
addDeviceCode(Map<string, string>, string)
add the authorization_code passed by the user to exchange for a token
function addDeviceCode(parameters: Map<string, string>, code: string)Parameters
- parameters
-
Map<string, string>
- code
-
string
addDomainHint(Map<string, string>, string)
add domain_hint
function addDomainHint(parameters: Map<string, string>, domainHint: string)Parameters
- parameters
-
Map<string, string>
- domainHint
-
string
addEARParameters(Map<string, string>, string)
Add EAR (Encrypted Authorize Response) request parameters
function addEARParameters(parameters: Map<string, string>, jwk: string)Parameters
- parameters
-
Map<string, string>
- jwk
-
string
addExtraQueryParameters(Map<string, string>, StringDict)
add extraQueryParams
function addExtraQueryParameters(parameters: Map<string, string>, eQParams: StringDict)Parameters
- parameters
-
Map<string, string>
- eQParams
- StringDict
addGrantType(Map<string, string>, string)
add grant type
function addGrantType(parameters: Map<string, string>, grantType: string)Parameters
- parameters
-
Map<string, string>
- grantType
-
string
addIdTokenHint(Map<string, string>, string)
add id_token_hint to logout request
function addIdTokenHint(parameters: Map<string, string>, idTokenHint: string)Parameters
- parameters
-
Map<string, string>
- idTokenHint
-
string
addInstanceAware(Map<string, string>)
function addInstanceAware(parameters: Map<string, string>)Parameters
- parameters
-
Map<string, string>
addLibraryInfo(Map<string, string>, LibraryInfo)
add library info query params
function addLibraryInfo(parameters: Map<string, string>, libraryInfo: LibraryInfo)Parameters
- parameters
-
Map<string, string>
- libraryInfo
-
LibraryInfo
addLoginHint(Map<string, string>, string)
add login_hint
function addLoginHint(parameters: Map<string, string>, loginHint: string)Parameters
- parameters
-
Map<string, string>
- loginHint
-
string
addLogoutHint(Map<string, string>, string)
Adds logout_hint parameter for "silent" logout which prevent server account picker
function addLogoutHint(parameters: Map<string, string>, logoutHint: string)Parameters
- parameters
-
Map<string, string>
- logoutHint
-
string
addNativeBroker(Map<string, string>)
Add flag to indicate STS should attempt to use WAM if available
function addNativeBroker(parameters: Map<string, string>)Parameters
- parameters
-
Map<string, string>
addNonce(Map<string, string>, string)
add nonce
function addNonce(parameters: Map<string, string>, nonce: string)Parameters
- parameters
-
Map<string, string>
- nonce
-
string
addOboAssertion(Map<string, string>, string)
add OBO assertion for confidential client flows
function addOboAssertion(parameters: Map<string, string>, oboAssertion: string)Parameters
- parameters
-
Map<string, string>
- oboAssertion
-
string
addPassword(Map<string, string>, string)
adds password for Password Grant flow
function addPassword(parameters: Map<string, string>, password: string)Parameters
- parameters
-
Map<string, string>
- password
-
string
addPopToken(Map<string, string>, string)
add pop_jwk to query params
function addPopToken(parameters: Map<string, string>, cnfString: string)Parameters
- parameters
-
Map<string, string>
- cnfString
-
string
addPostBodyParameters(Map<string, string>, StringDict)
Adds authorize body parameters to the request parameters
function addPostBodyParameters(parameters: Map<string, string>, bodyParameters: StringDict)Parameters
- parameters
-
Map<string, string>
- bodyParameters
- StringDict
addPostLogoutRedirectUri(Map<string, string>, string)
add post logout redirectUri
function addPostLogoutRedirectUri(parameters: Map<string, string>, redirectUri: string)Parameters
- parameters
-
Map<string, string>
- redirectUri
-
string
addPrompt(Map<string, string>, string)
add prompt
function addPrompt(parameters: Map<string, string>, prompt: string)Parameters
- parameters
-
Map<string, string>
- prompt
-
string
addRedirectUri(Map<string, string>, string)
add redirect_uri
function addRedirectUri(parameters: Map<string, string>, redirectUri: string)Parameters
- parameters
-
Map<string, string>
- redirectUri
-
string
addRefreshToken(Map<string, string>, string)
add the refreshToken passed by the user
function addRefreshToken(parameters: Map<string, string>, refreshToken: string)Parameters
- parameters
-
Map<string, string>
- refreshToken
-
string
addRequestTokenUse(Map<string, string>, string)
add grant type
function addRequestTokenUse(parameters: Map<string, string>, tokenUse: string)Parameters
- parameters
-
Map<string, string>
- tokenUse
-
string
addResponseMode(Map<string, string>, ResponseMode)
add response_mode. defaults to query.
function addResponseMode(parameters: Map<string, string>, responseMode?: ResponseMode)Parameters
- parameters
-
Map<string, string>
- responseMode
- ResponseMode
addResponseType(Map<string, string>, OAuthResponseType)
Add the given response_type
function addResponseType(parameters: Map<string, string>, responseType: OAuthResponseType)Parameters
- parameters
-
Map<string, string>
- responseType
- OAuthResponseType
addScopes(Map<string, string>, string[], boolean, string[])
add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios
function addScopes(parameters: Map<string, string>, scopes: string[], addOidcScopes?: boolean, defaultScopes?: string[])Parameters
- parameters
-
Map<string, string>
- scopes
-
string[]
- addOidcScopes
-
boolean
- defaultScopes
-
string[]
addServerTelemetry(Map<string, string>, ServerTelemetryManager)
add server telemetry fields
function addServerTelemetry(parameters: Map<string, string>, serverTelemetryManager: ServerTelemetryManager)Parameters
- parameters
-
Map<string, string>
- serverTelemetryManager
-
ServerTelemetryManager
addSid(Map<string, string>, string)
add sid
function addSid(parameters: Map<string, string>, sid: string)Parameters
- parameters
-
Map<string, string>
- sid
-
string
addSshJwk(Map<string, string>, string)
add SSH JWK and key ID to query params
function addSshJwk(parameters: Map<string, string>, sshJwkString: string)Parameters
- parameters
-
Map<string, string>
- sshJwkString
-
string
addState(Map<string, string>, string)
add state
function addState(parameters: Map<string, string>, state: string)Parameters
- parameters
-
Map<string, string>
- state
-
string
addThrottling(Map<string, string>)
Adds parameter that indicates to the server that throttling is supported
function addThrottling(parameters: Map<string, string>)Parameters
- parameters
-
Map<string, string>
addUsername(Map<string, string>, string)
adds username for Password Grant flow
function addUsername(parameters: Map<string, string>, username: string)Parameters
- parameters
-
Map<string, string>
- username
-
string
instrumentBrokerParams(Map<string, string>, string, IPerformanceClient)
function instrumentBrokerParams(parameters: Map<string, string>, correlationId?: string, performanceClient?: IPerformanceClient)Parameters
- parameters
-
Map<string, string>
- correlationId
-
string
- performanceClient
- IPerformanceClient