licenses
Creates, updates, deletes, gets or lists a licenses resource.
Overview
| Name | licenses |
| Type | Resource |
| Id | pagerduty.users.licenses |
Fields
The following fields are returned by SELECT queries:
- get
The License allocated to the User
| Name | Datatype | Description |
|---|---|---|
id | string | Uniquely identifies the resource |
name | string | Name of the License. |
description | string | Description of the License. May include the names of add-ons associated with the License, if there are any. |
html_url | string | HTML URL to access the License |
role_group | string | Indicates whether this License is assignable to full or stakeholder Users (FullUser, Stakeholder) (example: FullUser) |
self | string | API URL to access the License |
summary | string | Summary of the License |
type | string | Type of object |
valid_roles | array | The roles a User with this License can have |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id | Get the License allocated to a User<br /><br />Scoped OAuth requires: licenses.read<br /> |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the resource. |
SELECT examples
- get
Get the License allocated to a User<br /><br />Scoped OAuth requires: licenses.read<br />
SELECT
id,
name,
description,
html_url,
role_group,
self,
summary,
type,
valid_roles
FROM pagerduty.users.licenses
WHERE id = '{{ id }}' -- required
;