User Password and PIN Settings API
Listing User PIN Settings
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Listing User Password Settings
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Update Password/PIN Settings
For PIN:
|
For Password:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Unlock Password/PIN Settings
A user's PIN is the password that a user must enter over the phone to sign into their mailbox to listen or send new messages by phone. To change a user's PIN you need the object ID of the user. A user's password is the web application password that is required to interact with web applications, such as the Cisco PCA or the Inbox applications.
For Password:
|
For PIN:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example:
To Unlock Password:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
To Unlock Password
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Change Password/PIN
For Password: PUT
|
For PIN:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example:
To Update PIN
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Field Name | Data Type | Operation | Description |
---|---|---|---|
Locked | Boolean | Read/Write | A flag indicating whether access to the
user account associated with this set of credentials is locked.
Possible values:
Default value: false |
CantChange | Boolean | Read/Write | A flag indicating whether the user can set
this credential.
Possible values:
Default Value: false |
CredMustChange | Boolean | Read/Write | A flag indicating whether the user must
change their credentials (PIN or password) at the next login.
Possible values:
Default Value :true |
DoesntExpire | Boolean | Read/Write | A flag indicating whether this user
credential will expire, and therefore the user must change the credential
periodically. However, if the credential does not expire (value = "true"), the
user still may change the credential (if allowed by CantChange).
Possible values:
Default value: false |
CredentialPolicyObjectId | String(36) | Read/Write | The unique identifier of the CredentialPolicy object that is associated with this credential. Value for this parameter can be fetched from the objectid parameter. Response of the following URI: GET: https://<conection-server>/vmrest/credentialpolicies. |
TimeChanged | datetime(8) | Read/Write | The unique identifier of the CredentialPolicy object that is associated with this credential. Value for this parameter can be fetched from the objectid parameter. Response of the following URI: GET: https://<conection-server>/vmrest/credentialpolicies. |
HackCount | Integer(4) | Read/Write | The number of logon attempted that failed
due to invalid credentials. The Unity system or external authentication
provider determined that the credentials supplied as part of a user logon
attempt were invalid.
Default value: 0 |
TimeLastHack | datetime(8) | Read/Write | The date and time of the last logon attempt with an invalid user credential. |
TimeLockout | datetime(8) | Read/Write | The date and time that the credential was locked by an administrator. |
TimeHacked | datetime(8) | Read/Write | The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy. |
ObjectId | String (36) | Read Only | Unique identifier for the password/pin |
Credentials | String(256) | Read/Write | The PIN or password, for a user. The credentials are stored in an encrypted format. |
Alias | String(64) | Read/Write | A unique text name of the user. |
Hacked | Boolean | Read/Write | A flag indicating whether access to the
user account associated with this set of credentials is locked due too many
hack attempts.
Possible Values:
Default Value: false |
EncryptionType | Integer | Read/Write | Type of encryption that was used to
generate the credentials.
Possible values:(0-5)
Default Value: 0 |
CredentialType | CredentialType | Read/Write | The type of credential such as password,
PIN, Windows or Domino credential.
|