Jump to

• Request
• Response

Log In and Authenticate a User

post

/api/core/Login/executeLogin

Logs in the user with the specified user name and password.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Password: string
  The password.

  Example: password
• Username: string
  The user name.

  Example: admin

{
    "type":"object",
    "properties":{
        "Username":{
            "description":"The user name.",
            "type":"string",
            "example":"admin",
            "required":true
        },
        "Password":{
            "description":"The password.",
            "type":"string",
            "example":"password",
            "required":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SessionInfoRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SessionInfoRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object SessionInfoRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SessionInfoRead"
    }
}

Nested Schema : SessionInfoRead

Type: object

Show Source

• EmailAddress: string
  The email address.

  Example: [e-mail]
• FullName: string
  The full name of the user.

  Example: Example Name
• Locale: string
  The user's regional and language preferences.

  Example: en_US
• PasswordExpiration: integer
  The time when the password will expire, in seconds from epoch time.

  Example: 2147483647
• PermissionIDs: object PermissionIDs
  A JSON object with IDs of all the permissions that the user has.
• Permissions: object Permissions
  A JSON object with subobjects for the operations, such as create, update, delete, that are available to the user for each endpoint.
• Preferences: object Preferences
  An object showing the user preferences.
• Properties: object Properties
  A JSON object with restrictive property IDs.
• SamlUser: boolean
  Whether the user is a SAML user (1) or not (0).

  Example: false
• SupportPassword: string
  The support password.

  Example: example password
• SupportUsername: string
  The support username.

  Example: example username
• ThemeDir: string
  The theme selected by the user.

  Example: light
• TZ: string
  The user's time zone, represented in an abbreviated format depicting offset from UTC.

  Example: CST6CDT
• UserGroupID: integer
  The user group ID.

  Example: 1
• UserID: integer
  The user ID.

  Example: 1001
• Username: string
  The username.

  Example: admin

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1001"
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer",
            "example":"1"
        },
        "Username":{
            "description":"The username.",
            "type":"string",
            "example":"admin"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Example Name"
        },
        "PasswordExpiration":{
            "description":"The time when the password will expire, in seconds from epoch time.",
            "type":"integer",
            "example":"2147483647"
        },
        "SupportUsername":{
            "description":"The support username.",
            "type":"string",
            "example":"example username"
        },
        "SupportPassword":{
            "description":"The support password.",
            "type":"string",
            "example":"example password"
        },
        "EmailAddress":{
            "description":"The email address.",
            "type":"string",
            "example":"[e-mail]"
        },
        "SamlUser":{
            "description":"Whether the user is a SAML user (<b>1</b>) or not (<b>0</b>).",
            "type":"boolean",
            "example":false
        },
        "PermissionIDs":{
            "description":"A JSON object with IDs of all the permissions that the user has.",
            "type":"object",
            "example":{
                "AAAAuthTypes":"10021",
                "brokerServices":"11008"
            }
        },
        "Permissions":{
            "description":"A JSON object with subobjects for the operations, such as create, update, delete, that are available to the user for each endpoint.",
            "type":"object",
            "example":{
                "AAA":{
                    "AuthTypes":{
                        "read":true,
                        "create":false
                    },
                    "Permissions":{
                        "read":true,
                        "create":false
                    }
                }
            }
        },
        "Preferences":{
            "description":"An object showing the user preferences.",
            "type":"object",
            "example":{
                "PageSize":"1000",
                "RefreshRate":"60"
            }
        },
        "ThemeDir":{
            "description":"The theme selected by the user.",
            "type":"string",
            "example":"light"
        },
        "Locale":{
            "description":"The user's regional and language preferences.",
            "type":"string",
            "example":"en_US"
        },
        "Properties":{
            "description":"A JSON object with restrictive property IDs.",
            "type":"object",
            "example":{
                "RestrictiveDeviceGroupId":"1"
            }
        },
        "TZ":{
            "description":"The user's time zone, represented in an abbreviated format depicting offset from UTC.",
            "type":"string",
            "example":"CST6CDT"
        }
    }
}

Nested Schema : PermissionIDs

Type: object

A JSON object with IDs of all the permissions that the user has.

Example:

{
    "AAAAuthTypes":"10021",
    "brokerServices":"11008"
}

Nested Schema : Permissions

Type: object

A JSON object with subobjects for the operations, such as create, update, delete, that are available to the user for each endpoint.

Example:

{
    "AAA":{
        "AuthTypes":{
            "read":true,
            "create":false
        },
        "Permissions":{
            "read":true,
            "create":false
        }
    }
}

Nested Schema : Preferences

Type: object

An object showing the user preferences.

Example:

{
    "PageSize":"1000",
    "RefreshRate":"60"
}

Nested Schema : Properties

Type: object

A JSON object with restrictive property IDs.

Example:

{
    "RestrictiveDeviceGroupId":"1"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top