Methods for creating and managing shared authorization tokens
- Source:
Methods
static CreateShare({objectId,expiresAt,paramsoptional}) → Promise.<Object>
Create a share
Returns: Info about the created share
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectId |
string |
The object to create a share for |
|
expiresAt |
Date |
The expiration time of the share |
|
params |
Object |
<optional> |
Additional parameters |
- Source:
static RedeemShareToken({shareId}) → Promise.<Object>
Retrieve the authorization token for the specified share
Returns: The authorization token for the share
Parameters:
| Name | Type | Description |
|---|---|---|
shareId |
string |
The ID of the share |
- Source:
static RevokeShare({shareId})
Revoke the specified share
Parameters:
| Name | Type | Description |
|---|---|---|
shareId |
string |
The ID of the share to modify |
- Source:
static ShareInfo({shareId}) → Promise.<Object>
Retrieve info about the specified share
Returns: Info about the share
Parameters:
| Name | Type | Description |
|---|---|---|
shareId |
string |
The ID of the share |
- Source:
static Shares({objectIdoptional,limitoptional,offsetoptional}) → Promise.<Array.<Object>>
List shares associated with your tenancy
Returns: Info about the shares
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
objectId |
string |
<optional> |
If specified, the results will be limited shares for the specified object |
|
limit |
number |
<optional> |
100 |
Maximum number of results to return |
offset |
number |
<optional> |
0 |
Offset from which to return results |
- Source:
static UpdateShare({shareId,expiresAtoptional,paramsoptional}) → Promise.<Object>
Update the specified share
Returns: Info about the updated share
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
shareId |
string |
The ID of the share to modify |
|
expiresAt |
Date |
<optional> |
The new expiration time of the share |
params |
Object |
<optional> |
Additional parameters |
- Source: