SSO into the layout design phase. This endpoint allows customization of the layout and setting up signature blocks.

GET /api/v1/sso/layout/{layoutId}

Sample request:

GET /api/v1/sso/layout/{layoutId}?redirectUrl=https://example.com&language=en

Path parameters

  • layoutId string(uuid) Required

    The identifier for the layout.

Query parameters

  • redirectUrl string

    Redirect URL after customization.

  • language string

    Optional language parameter. If not supplied the language setting of the account will be used.

Responses

  • 200

    Success

  • default

    Error

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
GET /api/v1/sso/layout/{layoutId} 
curl \
 --request GET 'https://api.lwolf.com/authentisign/api/v1/sso/layout/{layoutId}'
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}

SSO into the layout design phase with account update. This endpoint allows customization of the layout and setting up signature blocks.

POST /api/v1/sso/layout/{layoutId}

Sample request:

POST /api/v1/sso/layout/{layoutId} { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "firstName": "John", "middleName": "D", "lastName": "Doe", "email": "john.doe@example.com", "phone": "555-5555", "company": "JD Inc", "clientId": "Client123", "clientFullName": "John Doe", "clientShortName": "JD", "timeZone": "EST", "gmtOffset": -5, "applyDST": true, "isExpired": false, "isValid": true, "isDisabled": false, "isDeleted": false, "language": "en", "isInitialized": true, "hasMoxiContacts": false, "lwaId": "LWA12345" }

Path parameters

  • layoutId string(uuid) Required

    The identifier for the layout.

Query parameters

  • redirectUrl string

    Redirect URL after customization.

  • Id

    Get or Set Account ID. This property represents the unique identifier of the account.

  • FirstName

    Get or Set First Name. This property represents the first name of the account holder.

  • MiddleName

    Get or Set Middle Name. This property represents the middle name of the account holder.

  • LastName

    Get or Set Last Name. This property represents the last name of the account holder.

  • Email

    Get or Set Email. This property represents the email address associated with the account.

  • Phone

    Get or Set Phone. This property represents the phone number associated with the account.

  • Company

    Get or Set Company. This property represents the company associated with the account.

  • ClientId

    Get or Set Client ID. This property represents the identifier of the client associated with the account.

  • ClientFullName

    Get or Set Client Full Name. This property represents the full name of the client associated with the account.

  • ClientShortName

    Get or Set Client Short Name. This property represents the short name of the client associated with the account.

  • TimeZone

    Get or Set Time Zone. This property represents the time zone of the account.

  • GMTOffset

    Get or Set GMT Offset. This property represents the Greenwich Mean Time (GMT) offset of the account's time zone.

  • ApplyDST

    Get or Set Apply DST. This property indicates whether Daylight Saving Time (DST) is applied to the account's time zone.

  • IsExpired

    Get or Set Is Expired. This property indicates whether the account is expired.

  • IsValid

    Get or Set Is Valid. This property indicates whether the account is valid.

  • IsDisabled

    Get or Set Is Disabled. This property indicates whether the account is disabled.

  • IsDeleted

    Get or Set Is Deleted. This property indicates whether the account is deleted.

  • Language

    Get or Set Language. This property represents the preferred language of the account holder.

  • IsInitialized

    Get or Set Is Initialized. This property indicates whether the account has been initialized.

  • HasMoxiContacts

    Get or Set Has Moxi Contacts. This property indicates whether the account has contacts in Moxi.

  • LwaId

    Get or Set LWA ID. This property represents the identifier used for linking with an external system, if applicable.

Body

Account details for SSO.

  • id string(uuid)
  • firstName string | null
  • middleName string | null
  • lastName string | null
  • email string | null
  • phone string | null
  • company string | null
  • clientId string | null
  • clientFullName string | null
  • clientShortName string | null
  • timeZone string | null
  • gmtOffset number(float)
  • applyDST boolean
  • isExpired boolean
  • isValid boolean
  • isDisabled boolean
  • isDeleted boolean
  • language string | null
  • isInitialized boolean
  • hasMoxiContacts boolean
  • lwaId string | null

Body

Account details for SSO.

  • id string(uuid)
  • firstName string | null
  • middleName string | null
  • lastName string | null
  • email string | null
  • phone string | null
  • company string | null
  • clientId string | null
  • clientFullName string | null
  • clientShortName string | null
  • timeZone string | null
  • gmtOffset number(float)
  • applyDST boolean
  • isExpired boolean
  • isValid boolean
  • isDisabled boolean
  • isDeleted boolean
  • language string | null
  • isInitialized boolean
  • hasMoxiContacts boolean
  • lwaId string | null

Body

Account details for SSO.

  • id string(uuid)
  • firstName string | null
  • middleName string | null
  • lastName string | null
  • email string | null
  • phone string | null
  • company string | null
  • clientId string | null
  • clientFullName string | null
  • clientShortName string | null
  • timeZone string | null
  • gmtOffset number(float)
  • applyDST boolean
  • isExpired boolean
  • isValid boolean
  • isDisabled boolean
  • isDeleted boolean
  • language string | null
  • isInitialized boolean
  • hasMoxiContacts boolean
  • lwaId string | null

Responses

  • 200

    Success

  • default

    Error

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
POST /api/v1/sso/layout/{layoutId} 
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/sso/layout/{layoutId}' \
 --header "Content-Type: application/json" \
 --data '{"id":"string","firstName":"string","middleName":"string","lastName":"string","email":"string","phone":"string","company":"string","clientId":"string","clientFullName":"string","clientShortName":"string","timeZone":"string","gmtOffset":42.0,"applyDST":true,"isExpired":true,"isValid":true,"isDisabled":true,"isDeleted":true,"language":"string","isInitialized":true,"hasMoxiContacts":true,"lwaId":"string"}'
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/sso/layout/{layoutId}' \
 --header "Content-Type: text/json"
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/sso/layout/{layoutId}' \
 --header "Content-Type: application/*+json"
Request examples 
{
  "id": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "company": "string",
  "clientId": "string",
  "clientFullName": "string",
  "clientShortName": "string",
  "timeZone": "string",
  "gmtOffset": 42.0,
  "applyDST": true,
  "isExpired": true,
  "isValid": true,
  "isDisabled": true,
  "isDeleted": true,
  "language": "string",
  "isInitialized": true,
  "hasMoxiContacts": true,
  "lwaId": "string"
}
Request examples 
{
  "id": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "company": "string",
  "clientId": "string",
  "clientFullName": "string",
  "clientShortName": "string",
  "timeZone": "string",
  "gmtOffset": 42.0,
  "applyDST": true,
  "isExpired": true,
  "isValid": true,
  "isDisabled": true,
  "isDeleted": true,
  "language": "string",
  "isInitialized": true,
  "hasMoxiContacts": true,
  "lwaId": "string"
}
Request examples 
{
  "id": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "company": "string",
  "clientId": "string",
  "clientFullName": "string",
  "clientShortName": "string",
  "timeZone": "string",
  "gmtOffset": 42.0,
  "applyDST": true,
  "isExpired": true,
  "isValid": true,
  "isDisabled": true,
  "isDeleted": true,
  "language": "string",
  "isInitialized": true,
  "hasMoxiContacts": true,
  "lwaId": "string"
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}