Resource access tokens
Get all resource access tokens
Returns all resource access tokens based on resource access token identifiers, reservations or interval. One of them must be specified in the request. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/resourceAccessTokens/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
ResourceAccessTokenIds
array of string
optional, max 1000 items
Unique identifiers of Resource access tokens. Required if no other filter is provided.
ServiceOrderIds
array of string
optional, max 1000 items
Unique identifiers of reservations. Required if no other filter is provided.
CollidingUtc
optional, max length 3 months
Interval in which the Resource access token is valid. Required if no other filter is provided.
ActivityStates
array of string Activity state
optional
Whether to return only active, only deleted or both records.
Response
Cursor
string
required
Unique identifier of the last and hence oldest item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older tokens. If Limitation is specified in the request message, then Cursor
will always be included in the response message.
Resource access token
ServiceOrderId
string
required
Unique identifier of a reservation.
Value
string
required
Value of resource access token
ValidityStartUtc
string
required
Marks the start of interval in which the resource access token can be used.
ValidityEndUtc
string
required
Marks the end of interval in which the resource access token can be used.
CreatedUtc
string
required
Creation date and time of the resource access token in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the resource access token in UTC timezone in ISO 8601 format.
IsActive
boolean
required
Whether the resource access token is still active.
Resource access token type
PinCode
RfidTag
Resource access token permissions
Add resource access tokens
Adds new resource access tokens with the specified data.
Request
[PlatformAddress]/api/connector/v1/resourceAccessTokens/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ResourceAccessTokenParameters
Array of Resource access token parameter
required, max 1000 items
Parameters of Resource access token.
Resource access token parameter
ServiceOrderId
string
required
Unique identifier of a reservation.
Value
string
required
Value of resource access token
ValidityStartUtc
string
required
Marks the start of interval in which the resource access token can be used.
ValidityEndUtc
string
required
Marks the end of interval in which the resource access token can be used.
Resource access token permission parameter
Response
Update resource access tokens
Updates the Resource access token validity interval and permissions that it grants.
Request
[PlatformAddress]/api/connector/v1/resourceAccessTokens/update
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ResourceAccessTokenUpdates
Array of Resource access token update
required
Parameters of Resource access token.
Resource access token update
ValidityStartUtc
optional
Marks the start of interval in which the resource access token can be used.
ValidityEndUtc
optional
Marks the end of interval in which the resource access token can be used.
Response
Delete resource access tokens
Delete specified resource access tokens.
Request
[PlatformAddress]/api/connector/v1/resourceAccessTokens/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
Response
Last updated