The following table provides the input and output information for ArcotID PKI operations:
|
Operation
(Function Used)
|
Input Required
|
Expected Output
|
|
Creating credential
(create())
|
- User name (userName).
- (Optional) Organization name (orgName).
- ArcotID password (password).
- (Optional) ArcotID attributes (unsignedAttributes).
- (Optional) Additional Input (AdditionalInput).
- (Optional) 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.
- (Optional) Custom attributes that you have maintained for each credential in your application.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting credential (resetCredentail())
|
- User name (userName).
- (Optional) Organization name (orgName).
- ArcotID password (password).
- (Optional) ArcotID attributes (unsignedAttributes).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Fetching credential
(fetch())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Reissuing credential (reissue())
|
- User name (userName).
- (Optional) Organization name (orgName).
- ArcotID password (password).
- (Optional) ArcotID attributes (unsignedAttributes).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting credential validity (resetValidity())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Time when the validity of the credential ends (validityEndTimeEx).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting custom attributes (resetNotes())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Custom attributes that you have maintained in your application.
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Disabling credential
(disable())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Enabling credential
(enable())
|
|
Deleting credential
(delete())
|
|
Setting ArcotID unsigned attribute
(setArcotIDUnsignedAttributes())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- ArcotID attributes (unsignedAttributes).
- (Optional) Profile name of the credential.
|
TransactionDetails
|
|
Adding key bag attributes
(addElements())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Certificate elements (elementSet).
- ArcotID key bag details (ArcotIDKeyBagElementSlection).
- (Optional) Profile name of the credential.
|
TransactionDetails
|
|
Fetching key bag attributes
(getElements())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- ArcotID key bag details (ArcotIDKeyBagElementSlection).
- (Optional) Profile name of the credential.
|
|
Deleting key bag attributes
(deleteElements())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Certificate element identifiers (elementIds).
- (Optional) Profile name of the credential.
|
|
Downloading Credential
(downloadCredential())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
|
Deleting unsigned attribute
(deleteArcotIDUnsignedAttributes())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Array of ArcotID unsigned attributes.
- (Optional) Profile name of the credential.
|
