Previous Topic: Fetching QnA ConfigurationNext Topic: Deleting Unsigned Attributes


Setting Unsigned Attributes

This sections explains the Web service that must be used to set the ArcotID PKI unsigned attributes. It walks you through following topics:

Note: This operation is applicable only for ArcotID PKI credential.

Preparing the Request Message

The SetArcotIDUnsignedAttributesRequestMessage is used to set the unsigned attributes of the ArcotID PKI. It contains the elements listed in the following table.

Element

Mandatory

Description

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 for whom the ArcotID PKI unsigned attributes have to be defined.

orgName

No

Specifies the organization name to which the user belongs to.

unsignedAttributes

Yes

Specifies the ArcotID PKI unsigned attributes in name-value pairs.

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

additionalInput

No

Specifies the extra information that must be sent to AuthMinder Server in name-value pairs.

  • name
    Indicates the name with which you want to pass additional information to the server.
  • value
    Indicates the corresponding value for the name.

Invoking the Web Service

To set the unsigned attributes for the ArcotID PKI of user, you need to implement the SetArcotIDUnsignedAttributes operation.

  1. (Optional) Include the authentication and authorization details in the SOAP header or in the additionalInput element of the SetArcotIDUnsignedAttributes operation. See chapter, "Managing Web Services Security" for more information on these details.
  2. Use the SetArcotIDUnsignedAttributes element to set the ArcotID PKI unsigned attributes.
  3. Use the userName and orgName elements to fetch the details of the user whose ArcotID PKI unsigned attributes you want to set.
  4. (Optional) If you are implementing a plug-in, then invoke the additionalInput element type to fill the additional input.

    This type provides the additional information that is set as a name-value pair.

  5. Use SetArcotIDUnsignedAttributesRequestMessage and construct the input message by using the details obtained in preceding steps.
  6. Invoke the SetArcotIDUnsignedAttributes operation of the ArcotWebFortIssuanceSvc service to set the ArcotID PKI unsigned attributes.

    This operation returns an instance of the SetArcotIDUnsignedAttributesResponseMessage that specifies the transaction details.

Interpreting the Response Message

For successful transactions, the response message, SetArcotIDUnsignedAttributesResponseMessage 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 "Error Codes" for more information on the SOAP error messages.

Element

Description

message

A string that defines the status of the operation.

reasonCode

Unique code that is sent by AuthMinder Server if the operation fails.

responseCode

Unique code that is sent by AuthMinder Server if the operation fails.

transactionID

Unique identifier of the transaction.

additionalOutput

The output for the additionalInput that was passed to AuthMinder Server.