SessionAuthModel interface

Package:

@azure/arm-securityinsight

Model for API authentication with session cookie.

Extends

CcpAuthConfig

Properties

headers	HTTP request headers to session service endpoint.
isPostPayloadJson	Indicating whether API key is set in HTTP POST payload.
password	The password attribute name.
queryParameters	Query parameters to session service endpoint.
sessionIdName	Session id attribute name from HTTP response header.
sessionLoginRequestUri	HTTP request URL to session service endpoint.
sessionTimeoutInMinutes	Session timeout in minutes.
type	The auth type
userName	The user name attribute key value.

Property Details

headers

HTTP request headers to session service endpoint.

headers?: Record<string, string>

Property Value

Record<string, string>

isPostPayloadJson

Indicating whether API key is set in HTTP POST payload.

isPostPayloadJson?: boolean

Property Value

boolean

password

The password attribute name.

password: Record<string, string>

Property Value

Record<string, string>

queryParameters

Query parameters to session service endpoint.

queryParameters?: Record<string, any>

Property Value

Record<string, any>

sessionIdName

Session id attribute name from HTTP response header.

sessionIdName?: string

Property Value

string

sessionLoginRequestUri

HTTP request URL to session service endpoint.

sessionLoginRequestUri?: string

Property Value

string

sessionTimeoutInMinutes

Session timeout in minutes.

sessionTimeoutInMinutes?: number

Property Value

number

type

The auth type

type: "Session"

Property Value

"Session"

userName

The user name attribute key value.

userName: Record<string, string>

Property Value

Record<string, string>