Common User Input

clientTxnId

No

Specifies the unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

userName

Yes

Specifies the unique identifier of the user whose credential has to be created.

orgName

No

Specifies the organization name to which the user belongs to.

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.

• name (The name with which you want to create the key pair.)
• value (The corresponding value for name.)

Some of the pre-defined additional input parameters include:

• AR_WF_LOCALE_ID
  Specifies the locale that AuthMinder will use while returning the messages back to your calling application.
• AR_WF_CALLER_ID
  This is useful in tracking transactions. You can use session ID or client transaction ID (clientTxnId) for specifying this information.

  Note: The additionalInput element is available at the end of the request message. You can add more than one of these elements.

Common Credential Input

notes

No

Specifies the additional information that you want to maintain for each credential in your application.

For example, if you do not want the user to download their ArcotID PKI on more than five systems, then you can create an attribute with this information.

You can set the custom attributes in name-value pairs.

• name
  Indicates the name with which you want to create the custom attribute.
• value
  Indicates the corresponding value for the name.

profileName

No

Specifies the profile name of the credential. If it is not passed, then the default profile for the organization is used. If it is passed, then the profile name must be available at the organization level.

validityEndTime

No

Specifies the duration for which the credential must be valid. The timestamp format is according to the XS:Timestamp.

validityEndTimeEx

No

Specifies the duration for which the credential must be valid. The validityEndTimeEx element uses the ArcotDateType structure.

The validityEndTimeEx element takes the following values:

• year
  The year when the validity period begins or ends.
• month
  The month when the validity period begins or ends.
• day
  The day on which the validity period begins or ends
• hour
  The hour at which the validity period begins or ends.
• minute
  The minute at which the validity period begins or ends.

• second
  The second at which the validity period begins or ends.
• dateType
  The start date or end date of the validity period. Following are the supported date types:
  1
  Uses the current date of AuthMinder Server to set the validity or disable period.
  2
  Indicates that the credential will be valid forever and will not expire.
  3
  Uses a date that is specified by your application to set the validity or disable period.
  4
  Uses a relative date corresponding to the disable start date. For example, if the relative date is one month, then the disable end date would be one month after the disable start date.

disableStartTime

No

If your users want to go on a vacation or on long leave, then their credentials can be disabled only for this period, after which the credential will be enabled automatically. This feature facilitates credential activation without the user making a request to User Administrator (UA) to do so.

The disableStartTime element is used to specify the duration from when the credential disable period must start. The values of this element are same as "validityEndTimeEx".

disableEndTime

No

Specifies when the credential disable period must end. The values of this element are same as "validityEndTimeEx".