ReleaseToken
(Control Token Manager)
Description: | Releases a control token from a tag |
Returns: | Nothing |
Usage: | Script Only. |
Function Groups: |
(Control Token Manager) |
Related to: |
CanControl (Control Token Manager) | CanDenyTokenRequest | CanGrantTokenRequest | CanReleaseToken | CanRequestToken | DenyTokenRequest | GetToken (Control Lock Module) | GetTokenLevel | GrantTokenRequest | ReleaseToken | RequestToken | |
Format: | ControlTokenManager.ReleaseToken(TagID, TokenGUID[, Custom, Timestamp, SessionID, AccountID, MachineID, Device]) |
Parameters: |
TagID |
Required string. The UniqueID of the tag from which to release the token. |
TokenGUID |
Required string. The GUID of the token to release |
Custom |
Optional. A structure of custom fields to log |
Timestamp |
Optional The UTC timestamp of this event. Defaults to current time |
SessionID |
Optional. The ID of session releasing the token. Relevant only if the token ownership is tied to the session. |
AccountID |
Optional. The Account ID of user releasing the token. Defaults to the currently signed-in user. |
MachineID |
Optional. The MachineID of the workstation where this request originated. Defaults to the current machine. |
Device |
Optional. Name of client device |
Comments: |
Releasing a token initiates an auto-granting mechanism where the ControlTokenManager will go through the list of Token Requests and grant all the Token Requests it can, starting from the oldest. |