public class CiClient
extends java.lang.Object
Constructor and Description |
---|
CiClient() |
Modifier and Type | Method and Description |
---|---|
static boolean |
basicAuthentication(CiServerConnection connection,
java.lang.String username,
java.lang.String password)
Performs username/password authentication against IBM Security Verify.
|
static boolean |
basicAuthentication(CiServerConnection connection,
java.lang.String username,
java.lang.String password,
java.lang.String locale)
Performs username/password authentication against IBM Security Verify.
|
static HttpResponse |
createFactorVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Create a verification for the specified enrollment.
|
static HttpResponse |
createTransaction(CiServerConnection connection,
java.lang.String authenticatorId,
java.lang.String json)
Create an IBM Verify transaction.
|
static HttpResponse |
createTransaction(CiServerConnection connection,
java.lang.String authenticatorId,
java.lang.String json,
java.lang.String locale)
Create an IBM Verify transaction.
|
static HttpResponse |
createTransientVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
createFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
createTransientVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
createFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
createVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
createFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
createVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
createFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
deleteAuthenticator(CiServerConnection connection,
java.lang.String id)
Delete the authenticator with the provided ID.
|
static HttpResponse |
deleteAuthenticator(CiServerConnection connection,
java.lang.String id,
java.lang.String locale)
Delete the authenticator with the provided ID.
|
static HttpResponse |
deleteAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
deleteFactor(CiServerConnection, String, String, String) |
static HttpResponse |
deleteAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
deleteFactor(CiServerConnection, String, String, String) |
static HttpResponse |
deleteFactor(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Delete a specific authentication factor with the provided ID and type.
|
static HttpResponse |
deleteRequest(CiServerConnection connection,
java.lang.String url)
Generic CI DELETE method.
|
static HttpResponse |
deleteRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String locale)
Generic CI DELETE method.
|
static HttpResponse |
enrollAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String json,
boolean respAsJson)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
enrollFactor(CiServerConnection, String, String, String, String) |
static HttpResponse |
enrollAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String json,
boolean respAsJson,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
enrollFactor(CiServerConnection, String, String, String, String) |
static HttpResponse |
enrollFactor(CiServerConnection connection,
java.lang.String type,
java.lang.String json,
java.lang.String queryParams,
java.lang.String locale)
Enroll an authentication factor with provided type and JSON payload.
|
static com.ibm.security.access.ciclient.CiClient.AccessToken |
getAccessToken(CiServerConnection connection)
Fetches the IBM Security Verify access token for the configured CI Server
Connection.
|
static HttpResponse |
getAuthenticator(CiServerConnection connection,
java.lang.String id)
Fetches a specific authenticator with the provided ID.
|
static HttpResponse |
getAuthenticator(CiServerConnection connection,
java.lang.String id,
java.lang.String locale)
Fetches a specific authenticator with the provided ID.
|
static HttpResponse |
getAuthenticators(CiServerConnection connection,
java.lang.String userId)
Fetch all authenticators registered with userId set as the owner.
|
static HttpResponse |
getAuthenticators(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale)
Fetch all authenticators that are owned by the provided SCIM user ID.
|
static HttpResponse |
getAuthenticators(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale,
java.lang.String search)
Fetch all authenticators that are owned by the provided SCIM user ID.
|
static HttpResponse |
getAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactor(CiServerConnection, String, String, String) |
static HttpResponse |
getAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactor(CiServerConnection, String, String, String) |
static HttpResponse |
getAuthMethods(CiServerConnection connection,
java.lang.String userId)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getAuthMethods(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getAuthMethods(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale,
java.lang.String search)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getFactor(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Fetch a specific authentication factor with the given type and ID.
|
static HttpResponse |
getFactors(CiServerConnection connection,
java.lang.String search,
java.lang.String locale)
Fetch a list of authentication factors based on an optional search string.
|
static HttpResponse |
getFactors(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale,
java.lang.String search)
Deprecated.
It is not recommended to use this method as it has the userId attribute
hardcoded. Use
getFactors(CiServerConnection, String, String) instead. |
static HttpResponse |
getFactorVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId,
java.lang.String locale)
Fetch a specific verification.
|
static HttpResponse |
getFactorVerifications(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Fetch a list of verifications for the provided authentication factor.
|
static HttpResponse |
getRequest(CiServerConnection connection,
java.lang.String url)
Generic CI get method.
|
static HttpResponse |
getRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String locale)
Generic CI get method.
|
static HttpResponse |
getSignatureAuthMethods(CiServerConnection connection,
java.lang.String userId,
boolean embeddedAttrs)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getSignatureAuthMethods(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale,
boolean embeddedAttrs)
Deprecated.
The authnmethods endpoint has been deprecated
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getSignatureAuthMethods(CiServerConnection connection,
java.lang.String userId,
java.lang.String locale,
boolean embeddedAttrs,
java.lang.String search)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactors(CiServerConnection, String, String) |
static HttpResponse |
getTransaction(CiServerConnection connection,
java.lang.String authenticatorId,
java.lang.String id)
Fetch a specific transaction for the provided authenticator ID.
|
static HttpResponse |
getTransaction(CiServerConnection connection,
java.lang.String authenticatorId,
java.lang.String transactionId,
java.lang.String locale)
Fetch a specific transaction for the provided authenticator ID.
|
static HttpResponse |
getTransactions(CiServerConnection connection,
java.lang.String authenticatorId)
Fetch all transactions for the provided authenticator ID.
|
static HttpResponse |
getTransactions(CiServerConnection connection,
java.lang.String authenticatorId,
java.lang.String locale)
Fetch all transactions for the provided authenticator ID.
|
static java.lang.String |
getUser(CiServerConnection connection,
java.lang.String username)
Fetches the IBM Security Verify user object as a JSON String.
|
static java.lang.String |
getUser(CiServerConnection connection,
java.lang.String username,
java.lang.String locale)
Fetches the IBM Security Verify user object as a JSON String.
|
static HttpResponse |
getValidation(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String validationId)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
getValidation(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String validationId,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
getVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
getVerification(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerification(CiServerConnection, String, String, String, String) |
static HttpResponse |
getVerifications(CiServerConnection connection,
java.lang.String type,
java.lang.String id)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerifications(CiServerConnection, String, String, String) |
static HttpResponse |
getVerifications(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
getFactorVerifications(CiServerConnection, String, String, String) |
static HttpResponse |
postRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String json)
Generic CI POST method.
|
static HttpResponse |
postRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String json,
java.lang.String locale)
Generic CI POST method.
|
static HttpResponse |
putRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String json)
Generic CI PUT method.
|
static HttpResponse |
putRequest(CiServerConnection connection,
java.lang.String url,
java.lang.String json,
java.lang.String locale)
Generic CI PUT method.
|
static HttpResponse |
registerAuthenticator(CiServerConnection connection,
java.lang.String json,
boolean respAsJson)
Registers an authenticator with IBM Security Verify.
|
static HttpResponse |
registerAuthenticator(CiServerConnection connection,
java.lang.String json,
boolean respAsJson,
java.lang.String locale)
Registers an authenticator with IBM Security Verify.
|
static HttpResponse |
updateAuthenticator(CiServerConnection connection,
java.lang.String id,
java.lang.String json)
Update an authenticator with the provided JSON payload.
|
static HttpResponse |
updateAuthenticator(CiServerConnection connection,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Update an authenticator with the provided JSON payload.
|
static HttpResponse |
updateAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
updateFactor(CiServerConnection, String, String, String, String) |
static HttpResponse |
updateAuthMethod(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
updateFactor(CiServerConnection, String, String, String, String) |
static HttpResponse |
updateFactor(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Update a specific authentication factor with the provided ID, type, and
JSON payload.
|
static HttpResponse |
validateOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String validationId,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
static HttpResponse |
validateOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String validationId,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
static HttpResponse |
verifyFactor(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId,
java.lang.String json,
java.lang.String locale)
Complete a verification with the provided payload for a specific
authentication factor.
|
static HttpResponse |
verifyOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
static HttpResponse |
verifyOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String id,
java.lang.String verificationId,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
static HttpResponse |
verifyTOTP(CiServerConnection connection,
java.lang.String id,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyTOTPFactor(CiServerConnection, String, String, String) |
static HttpResponse |
verifyTOTP(CiServerConnection connection,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyTOTPFactor(CiServerConnection, String, String, String) |
static HttpResponse |
verifyTOTPFactor(CiServerConnection connection,
java.lang.String id,
java.lang.String json,
java.lang.String locale)
Complete a TOTP verification with the provided OTP payload.
|
static HttpResponse |
verifyTransientOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String verificationId,
java.lang.String json)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
static HttpResponse |
verifyTransientOTP(CiServerConnection connection,
java.lang.String type,
java.lang.String verificationId,
java.lang.String json,
java.lang.String locale)
Deprecated.
The authnmethods endpoint has been deprecated.
Use
verifyFactor(CiServerConnection, String, String, String, String, String) |
public static com.ibm.security.access.ciclient.CiClient.AccessToken getAccessToken(CiServerConnection connection)
connection
- The CI Server Connection which contains details required for
the access token flow, client ID and client secret.public static java.lang.String getUser(CiServerConnection connection, java.lang.String username)
connection
- The CI Server Connection.username
- The username of the CI user.public static java.lang.String getUser(CiServerConnection connection, java.lang.String username, java.lang.String locale)
connection
- The CI Server Connection.username
- The username of the CI user.locale
- The locale to use in the Accept-Language header.public static boolean basicAuthentication(CiServerConnection connection, java.lang.String username, java.lang.String password)
connection
- The CI Server Connection.username
- The username of the CI user.password
- The password of the CI user.public static boolean basicAuthentication(CiServerConnection connection, java.lang.String username, java.lang.String password, java.lang.String locale)
connection
- The CI Server Connection.username
- The username of the CI user.password
- The password of the CI user.locale
- The locale to use in the Accept-Language header.public static HttpResponse registerAuthenticator(CiServerConnection connection, java.lang.String json, boolean respAsJson)
connection
- The CI Server Connection.json
- The authentication registration payload.respAsJson
- A boolean indicating if the response should be JSON or an
image.public static HttpResponse registerAuthenticator(CiServerConnection connection, java.lang.String json, boolean respAsJson, java.lang.String locale)
connection
- The CI Server Connection.json
- The authentication registration payload.respAsJson
- A boolean indicating if the response should be JSON or an
image.locale
- The locale to use in the Accept-Language header.public static HttpResponse getAuthenticators(CiServerConnection connection, java.lang.String userId)
connection
- The CI Server Connection.userId
- The user's SCIM ID.public static HttpResponse getAuthenticators(CiServerConnection connection, java.lang.String userId, java.lang.String locale)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.public static HttpResponse getAuthenticators(CiServerConnection connection, java.lang.String userId, java.lang.String locale, java.lang.String search)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.search
- The search parameters to apply to the request. Must be of the
form attribute=value. For example: "enabled=true"public static HttpResponse getFactors(CiServerConnection connection, java.lang.String search, java.lang.String locale)
connection
- The CI Server Connection.search
- The search parameters to apply to the request. Must be of the
form attribute=value. For example: 'userId="61200033O2"&validated=true'locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse getFactor(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "totp",
"emailotp", "smsotp", "fido2", etc.id
- The ID of the authentication factorlocale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse enrollFactor(CiServerConnection connection, java.lang.String type, java.lang.String json, java.lang.String queryParams, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "totp",
"emailotp", "smsotp", "fido2", etc.json
- The JSON payload of the enrollment.queryParams
- The query parameters to apply to the request. Must be of the
form key=value. For example: 'qrCodeInResponse=true'locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse getFactorVerifications(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "emailotp", "smsotp", etc.id
- The ID of the authentication factorlocale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse getFactorVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "emailotp", "smsotp", etc.id
- The ID of the authentication factorverificationId
- The ID of the verificationlocale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse createFactorVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "emailotp", "smsotp", etc.id
- The ID of the authentication factorjson
- The JSON payload of the enrollment.locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse updateFactor(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "totp",
"emailotp", "smsotp", "fido2", etc.id
- The ID of the authentication factorjson
- The JSON payload of the enrollment.locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse deleteFactor(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "totp",
"emailotp", "smsotp", "fido2", etc.id
- The ID of the authentication factorlocale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse verifyTOTPFactor(CiServerConnection connection, java.lang.String id, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.id
- The ID of the authentication factorjson
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse verifyFactor(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.type
- The type of the authentication factor. For example "emailotp", "smsotp", etc.id
- The ID of the authentication factorverificationId
- The ID of the verificationjson
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header, or null if not required.public static HttpResponse getFactors(CiServerConnection connection, java.lang.String userId, java.lang.String locale, java.lang.String search)
getFactors(CiServerConnection, String, String)
instead.connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header, or null if not required.search
- The search parameters to apply to the request. Must be of the
form attribute=value. For example: "validated=true"public static HttpResponse getAuthenticator(CiServerConnection connection, java.lang.String id)
connection
- The CI Server Connection.id
- The ID of the authenticatorpublic static HttpResponse getAuthenticator(CiServerConnection connection, java.lang.String id, java.lang.String locale)
connection
- The CI Server Connection.id
- The ID of the authenticatorlocale
- The locale to use in the Accept-Language header.public static HttpResponse updateAuthenticator(CiServerConnection connection, java.lang.String id, java.lang.String json)
connection
- The CI Server Connection.id
- The ID of the authenticatorjson
- The updated JSON payload of the authenticator.public static HttpResponse updateAuthenticator(CiServerConnection connection, java.lang.String id, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.id
- The ID of the authenticatorjson
- The updated JSON payload of the authenticator.locale
- The locale to use in the Accept-Language header.public static HttpResponse deleteAuthenticator(CiServerConnection connection, java.lang.String id)
connection
- The CI Server Connection.id
- The ID of the authenticatorpublic static HttpResponse deleteAuthenticator(CiServerConnection connection, java.lang.String id, java.lang.String locale)
connection
- The CI Server Connection.id
- The ID of the authenticatorlocale
- The locale to use in the Accept-Language header.public static HttpResponse getAuthMethods(CiServerConnection connection, java.lang.String userId)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.public static HttpResponse getAuthMethods(CiServerConnection connection, java.lang.String userId, java.lang.String locale)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.public static HttpResponse getAuthMethods(CiServerConnection connection, java.lang.String userId, java.lang.String locale, java.lang.String search)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.search
- The search parameters to apply to the request. Must be of the
form attribute=value. For example: "isValidated=true"public static HttpResponse getSignatureAuthMethods(CiServerConnection connection, java.lang.String userId, boolean embeddedAttrs)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.embeddedAttrs
- A flag indicating if the embedded attributes of the auth
method should be included (i.e. authenticator attributes).public static HttpResponse getSignatureAuthMethods(CiServerConnection connection, java.lang.String userId, java.lang.String locale, boolean embeddedAttrs)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.embeddedAttrs
- A flag indicating if the embedded attributes of the auth
method should be included (i.e. authenticator attributes).public static HttpResponse getSignatureAuthMethods(CiServerConnection connection, java.lang.String userId, java.lang.String locale, boolean embeddedAttrs, java.lang.String search)
getFactors(CiServerConnection, String, String)
connection
- The CI Server Connection.userId
- The user's SCIM ID.locale
- The locale to use in the Accept-Language header.embeddedAttrs
- A flag indicating if the embedded attributes of the auth
method should be included (i.e. authenticator attributes).search
- The search parameters to apply to the request. Must be of the
form attribute=value. For example: "isValidated=true"public static HttpResponse getAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id)
getFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodpublic static HttpResponse getAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
getFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodlocale
- The locale to use in the Accept-Language header.public static HttpResponse enrollAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String json, boolean respAsJson)
enrollFactor(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".json
- The JSON payload of the enrollment.respAsJson
- A boolean indicating if the response should be JSON or an
image.public static HttpResponse enrollAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String json, boolean respAsJson, java.lang.String locale)
enrollFactor(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".json
- The JSON payload of the enrollment.respAsJson
- A boolean indicating if the response should be JSON or an
image.locale
- The locale to use in the Accept-Language header.public static HttpResponse updateAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json)
updateFactor(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodjson
- The JSON payload of the enrollment.public static HttpResponse updateAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json, java.lang.String locale)
updateFactor(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodjson
- The JSON payload of the enrollment.locale
- The locale to use in the Accept-Language header.public static HttpResponse deleteAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id)
deleteFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodpublic static HttpResponse deleteAuthMethod(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
deleteFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of "totp",
"emailotp", or "smsotp".id
- The ID of the authentication methodlocale
- The locale to use in the Accept-Language header.public static HttpResponse getValidation(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String validationId)
getFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodvalidationId
- The ID of the validationpublic static HttpResponse getValidation(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String validationId, java.lang.String locale)
getFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodvalidationId
- The ID of the validationlocale
- The locale to use in the Accept-Language header.public static HttpResponse validateOTP(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String validationId, java.lang.String json)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodvalidationId
- The ID of the validationjson
- The JSON payload of the validation.public static HttpResponse validateOTP(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String validationId, java.lang.String json, java.lang.String locale)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodvalidationId
- The ID of the validationjson
- The JSON payload of the validation.locale
- The locale to use in the Accept-Language header.public static HttpResponse createVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json)
createFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodjson
- The JSON payload of the enrollment.public static HttpResponse createVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String json, java.lang.String locale)
createFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodjson
- The JSON payload of the enrollment.locale
- The locale to use in the Accept-Language header.public static HttpResponse createTransientVerification(CiServerConnection connection, java.lang.String type, java.lang.String json)
createFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".json
- The JSON payload of the verification.public static HttpResponse createTransientVerification(CiServerConnection connection, java.lang.String type, java.lang.String json, java.lang.String locale)
createFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".json
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header.public static HttpResponse getVerifications(CiServerConnection connection, java.lang.String type, java.lang.String id)
getFactorVerifications(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodpublic static HttpResponse getVerifications(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String locale)
getFactorVerifications(CiServerConnection, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodlocale
- The locale to use in the Accept-Language header.public static HttpResponse getVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId)
getFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodverificationId
- The ID of the verificationpublic static HttpResponse getVerification(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId, java.lang.String locale)
getFactorVerification(CiServerConnection, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodverificationId
- The ID of the verificationlocale
- The locale to use in the Accept-Language header.public static HttpResponse verifyTOTP(CiServerConnection connection, java.lang.String id, java.lang.String json)
verifyTOTPFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.id
- The ID of the authentication methodjson
- The JSON payload of the verification.public static HttpResponse verifyTOTP(CiServerConnection connection, java.lang.String id, java.lang.String json, java.lang.String locale)
verifyTOTPFactor(CiServerConnection, String, String, String)
connection
- The CI Server Connection.id
- The ID of the authentication methodjson
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header.public static HttpResponse verifyOTP(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId, java.lang.String json)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodverificationId
- The ID of the verificationjson
- The JSON payload of the verification.public static HttpResponse verifyOTP(CiServerConnection connection, java.lang.String type, java.lang.String id, java.lang.String verificationId, java.lang.String json, java.lang.String locale)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".id
- The ID of the authentication methodverificationId
- The ID of the verificationjson
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header.public static HttpResponse verifyTransientOTP(CiServerConnection connection, java.lang.String type, java.lang.String verificationId, java.lang.String json)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".verificationId
- The ID of the verificationjson
- The JSON payload of the verification.public static HttpResponse verifyTransientOTP(CiServerConnection connection, java.lang.String type, java.lang.String verificationId, java.lang.String json, java.lang.String locale)
verifyFactor(CiServerConnection, String, String, String, String, String)
connection
- The CI Server Connection.type
- The type of the authentication method. Can be one of
"emailotp", or "smsotp".verificationId
- The ID of the verificationjson
- The JSON payload of the verification.locale
- The locale to use in the Accept-Language header.public static HttpResponse createTransaction(CiServerConnection connection, java.lang.String authenticatorId, java.lang.String json)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatorjson
- The JSON payload of the transaction.public static HttpResponse createTransaction(CiServerConnection connection, java.lang.String authenticatorId, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatorjson
- The JSON payload of the transaction.locale
- The locale to use in the Accept-Language header.public static HttpResponse getTransactions(CiServerConnection connection, java.lang.String authenticatorId)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatorpublic static HttpResponse getTransactions(CiServerConnection connection, java.lang.String authenticatorId, java.lang.String locale)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatorlocale
- The locale to use in the Accept-Language header.public static HttpResponse getTransaction(CiServerConnection connection, java.lang.String authenticatorId, java.lang.String id)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatortransactionId
- The ID of the transactionpublic static HttpResponse getTransaction(CiServerConnection connection, java.lang.String authenticatorId, java.lang.String transactionId, java.lang.String locale)
connection
- The CI Server Connection.authenticatorId
- The ID of the authenticatortransactionId
- The ID of the transactionlocale
- The locale to use in the Accept-Language header.public static HttpResponse getRequest(CiServerConnection connection, java.lang.String url)
connection
- The CI Server Connection.url
- The URL to GETpublic static HttpResponse getRequest(CiServerConnection connection, java.lang.String url, java.lang.String locale)
connection
- The CI Server Connection.url
- The URL to GETlocale
- The locale to use in the Accept-Language header.public static HttpResponse postRequest(CiServerConnection connection, java.lang.String url, java.lang.String json)
connection
- The CI Server Connection.url
- The URL to POSTjson
- The JSON payload.public static HttpResponse postRequest(CiServerConnection connection, java.lang.String url, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.url
- The URL to POSTjson
- The JSON payload.locale
- The locale to use in the Accept-Language header.public static HttpResponse putRequest(CiServerConnection connection, java.lang.String url, java.lang.String json)
connection
- The CI Server Connection.url
- The URL to PUTjson
- The JSON payload.public static HttpResponse putRequest(CiServerConnection connection, java.lang.String url, java.lang.String json, java.lang.String locale)
connection
- The CI Server Connection.url
- The URL to PUTjson
- The JSON payload.locale
- The locale to use in the Accept-Language header.public static HttpResponse deleteRequest(CiServerConnection connection, java.lang.String url)
connection
- The CI Server Connection.url
- The URL to DELETEpublic static HttpResponse deleteRequest(CiServerConnection connection, java.lang.String url, java.lang.String locale)
connection
- The CI Server Connection.url
- The URL to DELETElocale
- The locale to use in the Accept-Language header.