Get Auth API application
GET/api/web/v1/applications/authapi/:id
Get the specified auth API application. Caller requires the APPLICATIONS:VIEW permission.
Request
Path Parameters
The UUID of the application to be fetched.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Defines whether ignore ip address for rba will be allowed or not.
Application template specific to this application type.
Application template id specific to this application type.
Possible values: [NOT_INCLUDED
, PROVIDED
, FROM_CONNECTION
]
Indicates the source of client IP address for risk analysis
Short description of application.
Application id.
Base64 encoded logo image.
Name of application.
Flag indicating if passkey authentication is allowed for this application. This flag has been deprecated and is no longer used.
protectedOfflineSettings
object
Offline token settings to support offline token feature for IntelliTrust Desktop applications.
Maximum number of IntelliTrust Desktops (or clients in general) that are allowed to be registered with a token for downloading OTPs.
Maximum number of hours' worth of offline OTPs that a client is allowed to possess.
Default number of hours' worth of offline OTPs that is returned.
Possible values: [NORMAL
, STRONG
, VERYSTRONG
]
This controls the length of the private salt and is measured in bits. The values map as follows: Normal = 14, Strong = 17, and Very Strong = 20
Defines whether tokens can be used offline.
Defines whether user values function is enabled.
Defines whether verification for a user must be satisfied.
{
"allowIgnoreIpAddressForRba": true,
"applicationTemplate": "Authentication API",
"applicationTemplateId": "00dc1d40-b512-4159-bccc-e8c1b4524515",
"clientIpSource": "FROM_CONNECTION",
"description": "application for testing",
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"logo": "string",
"name": "authApiApplication",
"protectedOfflineSettings": {
"protectedOfflineOTPMaxClients": 0,
"protectedOfflineOTPMaxRefill": 0,
"protectedOfflineOTPMinorRefill": 0,
"protectedOfflineOTPProtection": "NORMAL",
"protectedOfflineOTPSupport": true
},
"userValuesEnabled": true,
"verificationRequired": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}