Jump to

• Request
• Response

Get an Authentication Type by ID

get

/api/AAA/AuthTypes/{id}

Gets the authentication type that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The authentication type ID.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object AAAAuthTypesRead

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

Nested Schema : AAAAuthTypesRead

Type: object

Show Source

• AuthenticationStatus: boolean
  Whether the authentication is enabled or not.

  Example: 1
• AuthenticationStatusIcon: string
  The authentication status icon.

  Example: OrbGreen.png
• AuthenticationTypeID: integer
  The authentication type ID.

  Example: 1
• AuthenticationTypeName: string
  The authentication type name.

  Example: Internal
• PasswordMinimumLength: integer
  The minimum password length. This is used for internal authorization only.

  Example: 4
• PasswordRequiredLowercase: integer
  The minimum number of lowercase letters required in the password. This is used for internal authorization only.

  Example: 1
• PasswordRequiredNumbers: integer
  The minimum number of numerals required in the password. This is used for internal authorization only.

  Example: 0
• PasswordRequiredSpecialCharacters: integer
  The minimum number of special characters required in the password. This is used for internal authorization only.

  Example: 0
• PasswordRequiredUppercase: integer
  The minimum number of uppercase letters required in the password. This is used for internal authorization only.

  Example: 0
• PasswordResetAvailable: integer
  The number of password resets available. This is used for internal authorization only.

  Example: 0
• PasswordResetCustomText: string
  PasswordResetCustomText - used for Internal auth only

  Example:
• PasswordResetQuestion1: string
  PasswordResetQuestion1 - used for Internal auth only

  Example:

{
    "properties":{
        "AuthenticationTypeID":{
            "description":"The authentication type ID.",
            "type":"integer",
            "example":"1"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type name.",
            "type":"string",
            "example":"Internal"
        },
        "AuthenticationStatusIcon":{
            "description":"The authentication status icon.",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "AuthenticationStatus":{
            "description":"Whether the authentication is enabled or not.",
            "type":"boolean",
            "example":"1"
        },
        "PasswordMinimumLength":{
            "description":"The minimum password length. This is used for internal authorization only.",
            "type":"integer",
            "example":"4"
        },
        "PasswordRequiredLowercase":{
            "description":"The minimum number of lowercase letters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"1"
        },
        "PasswordRequiredNumbers":{
            "description":"The minimum number of numerals required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordRequiredSpecialCharacters":{
            "description":"The minimum number of special characters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordRequiredUppercase":{
            "description":"The minimum number of uppercase letters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordResetAvailable":{
            "description":"The number of password resets available. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordResetCustomText":{
            "description":"PasswordResetCustomText  - used for Internal auth only",
            "type":"string",
            "example":""
        },
        "PasswordResetQuestion1":{
            "description":"PasswordResetQuestion1  - used for Internal auth only",
            "type":"string",
            "example":""
        }
    },
    "type":"object"
}

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top