TokenInfo Object
Click the links below to view the TokenInfo Object properties and an example.
TokenInfo Object Properties
patronId
string
The associated patron ID; applies only to authorization code grant sessions.
Example:
"patronId": "3159578"
keyId
string
The key ID.
Example:
"keyId": "0HSoFauxNw2tQPYNJhANZ/aJ3zSS"
grantType
string
The grant type. For example, authorization code grant or client credentials grant.
Example:
"grantType": "client_credentials"
authorizationScheme
string
The authorization scheme, such as 'Bearer' or 'Basic'.
Example:
"authorizationScheme": "Bearer"
expiresIn
integer
The remaining time (in seconds) after which the token expires.
Example:
"expiresIn": 3595
roles
array
The roles property contains a TokenInfoRole object, which lists and describes the user roles associated with the current token.
See Administering Sierra API Client Keys in the Sierra WebHelp for more information about Sierra API roles and permissions.
Example
"roles": [
{
"name": "DEVELOPER",
"tokenLifetime": 3600,
"permissions": [
"Acquisitions_Orders_Create",
"Authorities_List",
"Authorities_Read",
"Authorities_Read_Marc",
"Bibs_Delete_Marc",
"Bibs_List",
"Bibs_Read",
"Bibs_Read_Marc",
"Branches_List",
"Branches_Read",
"Info_Token_Read",
"Items_List",
"Items_Read",
"Orders_Funds_Read",
"Orders_List",
"Orders_Read"
]
}
]
Child Properties
name
string
The role name.
Example:
"name": "DEVELOPER"
tokenLifetime
integer
The token's lifetime in seconds.
Example:
"tokenLifetime": 3600
permissions
array
A list of the permissions authorized for the token (user).
Example
"permissions": [
"Acquisitions_Orders_Create",
"Authorities_List",
"Authorities_Read",
"Authorities_Read_Marc",
"Bibs_Delete_Marc",
"Bibs_List",
"Bibs_Read",
"Bibs_Read_Marc",
"Branches_List",
"Branches_Read",
"Info_Token_Read",
"Items_List",
"Items_Read",
"Orders_Funds_Read",
"Orders_List",
"Orders_Read"
]
The preceding list order reflects the sequence in which the data returns.
TokenInfo Object Example
Example response for:
https://example-library.edu:443/iii/sierra-api/v6/info/token{
"keyId": "0HSoFauxNw2tQPYNJhANZ/aJ3zSS",
"grantType": "client_credentials",
"authorizationScheme": "Bearer",
"expiresIn": 3572,
"roles": [
{
"name": "Invoices_Write",
"tokenLifetime": 3600,
"permissions": [
"Invoices_Create",
"Invoices_Post",
"Invoices_Update"
]
},
{
"name": "Fines_Read",
"tokenLifetime": 3600,
"permissions": [
"Fines_List"
]
},
{
"name": "Vendors_Read",
"tokenLifetime": 3600,
"permissions": [
"Vendors_List"
]
},
{
"name": "Patrons_Read",
"tokenLifetime": 3600,
"permissions": [
"Patrons_Checkouts_History_List",
"Patrons_Checkouts_List",
"Patrons_Checkouts_Read",
"Patrons_Filter",
"Patrons_Find",
"Patrons_Fines_List",
"Patrons_Fines_Read",
"Patrons_Hold_Form_Read",
"Patrons_Hold_List",
"Patrons_Hold_Read",
"Patrons_List",
"Patrons_Metadata_Read",
"Patrons_Read"
]
},
{
"name": "Invoices_Read",
"tokenLifetime": 3600,
"permissions": [
"Invoices_List",
"Invoices_Metadata_Read",
"Invoices_Read"
]
},
{
"name": "Holds_Read",
"tokenLifetime": 3600,
"permissions": [
"Holds_List"
]
},
{
"name": "Courses_Read",
"tokenLifetime": 3600,
"permissions": [
"Courses_List"
]
},
{
"name": "Acquisitions_Write",
"tokenLifetime": 3600,
"permissions": [
"Acquisitions_Orders_Create"
]
},
{
"name": "Branches_Read",
"tokenLifetime": 3600,
"permissions": [
"Branches_List",
"Branches_PickupLocations_List",
"Branches_Read"
]
},
{
"name": "Title_Pages_Read",
"tokenLifetime": 3600,
"permissions": [
"Title_Pages_List"
]
},
{
"name": "Holdings_Write",
"tokenLifetime": 3600,
"permissions": [
"Holdings_Delete_Marc"
]
},
{
"name": "Patrons_Write",
"tokenLifetime": 3600,
"permissions": [
"Patrons_Checkouts_Create",
"Patrons_Checkouts_Delete",
"Patrons_Checkouts_History_Configure",
"Patrons_Checkouts_History_Delete",
"Patrons_Checkouts_Renew",
"Patrons_Create",
"Patrons_Delete",
"Patrons_Fines_Add",
"Patrons_Fines_Pay",
"Patrons_Hold_Delete",
"Patrons_Hold_Request_Create",
"Patrons_Hold_Update",
"Patrons_Update",
"Patrons_Validate",
"Patrons_Verify_Pin"
]
},
{
"name": "Orders_Read",
"tokenLifetime": 3600,
"permissions": [
"Orders_Filter",
"Orders_Funds_Read",
"Orders_List",
"Orders_Read"
]
},
{
"name": "Currencies_Read",
"tokenLifetime": 3600,
"permissions": [
"Currencies_List"
]
},
{
"name": "Info_Holds_Config",
"tokenLifetime": 3600,
"permissions": [
"Info_Holds_Config_Read"
]
},
{
"name": "Bibs_Read",
"tokenLifetime": 3600,
"permissions": [
"Bibs_Filter",
"Bibs_List",
"Bibs_Metadata_Read",
"Bibs_Read",
"Bibs_Read_Marc",
"Bibs_Search"
]
},
{
"name": "Funds_Read",
"tokenLifetime": 3600,
"permissions": [
"Funds_List"
]
},
{
"name": "Holdings_Read",
"tokenLifetime": 3600,
"permissions": [
"Holdings_List",
"Holdings_Read_Marc"
]
},
{
"name": "Authorities_Read",
"tokenLifetime": 3600,
"permissions": [
"Authorities_Filter",
"Authorities_List",
"Authorities_Read",
"Authorities_Read_Marc"
]
},
{
"name": "Agencies_Read",
"tokenLifetime": 3600,
"permissions": [
"Agencies_List"
]
},
{
"name": "Bibs_Write",
"tokenLifetime": 3600,
"permissions": [
"Bibs_Create",
"Bibs_Delete",
"Bibs_Delete_Marc",
"Bibs_Update"
]
},
{
"name": "Items_Write",
"tokenLifetime": 3600,
"permissions": [
"Items_Create",
"Items_Delete",
"Items_Update"
]
},
{
"name": "Item_Scans_Read",
"tokenLifetime": 3600,
"permissions": [
"Item_Scans_List"
]
},
{
"name": "Patrons_Holds_CRUD",
"tokenLifetime": 3600,
"permissions": [
"Patrons_Hold_Delete",
"Patrons_Hold_Form_Read",
"Patrons_Hold_List",
"Patrons_Hold_Read",
"Patrons_Hold_Request_Create",
"Patrons_Hold_Update"
]
},
{
"name": "Patrons_Validate",
"tokenLifetime": 3600,
"permissions": [
"Patrons_Validate",
"Patrons_Verify_Pin"
]
},
{
"name": "Volumes_Read",
"tokenLifetime": 3600,
"permissions": [
"Volumes_List",
"Volumes_Read"
]
},
{
"name": "Users_Write",
"tokenLifetime": 3600,
"permissions": [
"Users_Validate"
]
},
{
"name": "Items_Read",
"tokenLifetime": 3600,
"permissions": [
"Items_Checkouts_List",
"Items_Checkouts_Read",
"Items_Filter",
"Items_List",
"Items_Read"
]
}
]
}