The AuthMinder Authentication Web service provides an appropriate token to the end user after they authenticate successfully. The token is then presented to AuthMinder Server, indicating that the user is authenticated and can be provided access to the protected resources.
By using the Authentication Web service, you can specify whether the token has to be returned after authentication or not. In addition, you can also specify the type of the token that must be returned after authentication. The tokenType element specifies the return token type and supports the following types of tokens:
Specify this type when CA-proprietary (or Native) token is required after successful authentication. This token can be used multiple times before it expires.
Specify this type when one-time token is required after successful authentication. This token can be used only one time before it expires.
Secure Assertion Markup Language (SAML) is an open standard, which specifies the format of the authentication data exchanged between security domains. The Native, Default, and One-Time tokens issued by AuthMinder can only be interpreted by the AuthMinder Server, but the SAML tokens issued by the AuthMinder Server can be interpreted by any other authentication system. AuthMinder supports 1.1 and 2.0 versions of SAML:
Specify this type of token when you are using custom (non-AuthMinder) authentication mechanism that needs SAML 1.1 tokens after successful authentication.
Specify this type of token when you are using custom (non-AuthMinder) authentication mechanism that needs SAML 2.0 tokens after successful authentication.
Specify this type of token when the default token configured at the server is to be requested after successful authentication.
AuthMinder Server can verify only the Native and One-Time tokens that are issued to the users. The authentication token must be verified in cases when you use the token for Single Sign-On, wherein you authenticate the user once and allow them to use multiple resources using the same authentication token.
This section walks you through the following topics for verifying authentication tokens:
The VerifyAuthTokenRequestMessage is used to verify the authentication token returned by AuthMinder Server. The following table lists the elements of this message.
|
Element |
Mandatory |
Description |
|---|---|---|
|
clientTxnId |
No |
Specifies the unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions. |
|
token |
No |
The authentication token that is returned to the user after successful authentication. |
|
additionalInput/pairs |
No |
AuthMinder’s additionalInput element enables you to set additional inputs if you want to augment AuthMinder’s authentication capability by specifying additional information. In such cases, you need to set the extra information in name-value pairs.
Some of the pre-defined additional input parameters include:
|
To verify if a token is valid or not:
This operation returns VerifyAuthTokenResponseMessage, which provides the credential and transaction details.
For successful transactions, the response message, VerifyAuthTokenResponseMessage returns the elements explained in the following table. These elements are included in the SOAP body. If there are any errors, then the Fault response is included in the SOAP body. See appendix, "Error Codes" for more information on the SOAP error messages.
|
Method |
Description |
|---|---|
|
userName |
The name of the user to whom the authentication token belongs to. |
|
orgName |
The organization to which the user belongs to. |
|
transactionDetails |
Contains the following transaction details:
|
|
Copyright © 2013 CA.
All rights reserved.
|
|