Licenses | Hitchhikers

License Assignment: Create

This is used to assign a license to an entity.

path Parameters

accountId required	string
licensePackId required	string License Pack ID found on the Account Settings / License Packs page.
entityId required	string The external ID of the requested Entity.

query Parameters

v required	string A date in `YYYYMMDD` format.
api_key required	string All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"licensePack": {"id": "string",
"name": "string",
"total": 0,
"assigned": 0,
"available": 0,
"notes": "string"
},
"assignedEntities": [{"entityId": "string",
"expirationDate": "string"
}
]
}
}

License Assignment: Delete

This is used to immediately remove a license from an entity.

path Parameters

accountId required	string
licensePackId required	string License Pack ID found on the Account Settings / License Packs page.
entityId required	string The external ID of the requested Entity.

query Parameters

v required	string A date in `YYYYMMDD` format.
api_key required	string All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

License Assignment: Update

This is used to schedule future removal of a license from an entity by specifying an expiration date. A user can also omit an expiration date or specify an expiration date of null, which would cancel that future removal.

path Parameters

accountId required	string
licensePackId required	string License Pack ID found on the Account Settings / License Packs page.
entityId required	string The external ID of the requested Entity.

query Parameters

v required	string A date in `YYYYMMDD` format.
api_key required	string All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials.

Request Body schema: application/json

expirationDate

string

The license will be unassigned at the beginning of the day on this date.

Responses

Request samples

Payload

Content type

application/json

{"expirationDate": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"licensePack": {"id": "string",
"name": "string",
"total": 0,
"assigned": 0,
"available": 0,
"notes": "string"
},
"assignedEntities": [{"entityId": "string",
"expirationDate": "string"
}
]
}
}

License Packs: List

This is used to list all active license packs on the account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
api_key required	string All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials.
pageSize	integer Number of results to return.
pageToken	string If a response to a previous request contained the `nextPageToken` field, pass that field's value as the `pageToken` parameter to retrieve the next page of data.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"licensePacks": [{"id": "string",
"name": "string",
"total": 0,
"assigned": 0,
"available": 0,
"notes": "string"
}
],
"nextPageToken": "string"
}
}

License Assignments: List

This is used to list all licenses that have been assigned to an entity. Users can specify all license packs using a wildcard "-" as the licensePackId, which allows them to request all license assignments for that entity.

path Parameters

accountId required	string
licensePackId required	string License Pack ID found on the Account Settings / License Packs page.

query Parameters

v required	string A date in `YYYYMMDD` format.
api_key required	string All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials.
pageSize	integer Number of results to return.
pageToken	string If a response to a previous request contained the `nextPageToken` field, pass that field's value as the `pageToken` parameter to retrieve the next page of data.
assignedEntity	string If you want to list all of the license packs assigned to a specific entity, you can provide the entity's external ID as a parameter.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"licenseAssignments": [{"licensePack": {"id": "string",
"name": "string",
"total": 0,
"assigned": 0,
"available": 0,
"notes": "string"
},
"assignedEntities": [{"entityId": "string",
"expirationDate": "string"
}
]
}
],
"nextPageToken": "string"
}
}