Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Available from CRM.COM R14.0.0


Excerpt

This method is creating Set User Parameters provisioning requests in a pending life cycle state, by specifying the smartcard, and the subscription that the smartcard should belong to.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier 

(mandatory)

Subscription identifier

The subscription that the smartcard belongs to. The available subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

smartcard_identifier

(mandatory)

String

The smartcard CA ID

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

process_immediately

(optional)

booleanDefines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately

reset_pin

(semi-optional)

booleanDefines whether the PIN code will be reset to the default value or not.

new_pin

(semi-optional)

StringThe new PIN code that will be set on the Smartcard

scheduled_date

(optional)

dateThe date that the provisioning request is scheduled to be processed. If not specified and process_immediately is also set to false, then the provisioning request will be processed immediately

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Examples

Expand
titleExample 1

HTTP Method: POST


Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue


...