SessionAuthModel interface
Model for API authentication with session cookie.
- Extends
Properties
| headers | HTTP request headers to session service endpoint. |
| is |
Indicating whether API key is set in HTTP POST payload. |
| password | The password attribute name. |
| query |
Query parameters to session service endpoint. |
| session |
Session id attribute name from HTTP response header. |
| session |
HTTP request URL to session service endpoint. |
| session |
Session timeout in minutes. |
| type | The auth type |
| user |
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?: booleanProperty 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?: stringProperty Value
string
sessionLoginRequestUri
HTTP request URL to session service endpoint.
sessionLoginRequestUri?: stringProperty Value
string
sessionTimeoutInMinutes
Session timeout in minutes.
sessionTimeoutInMinutes?: numberProperty 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>
