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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : AAAAuthTypesRead
Type:
Show Source
object
-
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 onlyExample:
-
PasswordResetQuestion1: string
PasswordResetQuestion1 - used for Internal auth onlyExample:
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object