Skip to main content

licenses

Creates, updates, deletes, gets or lists a licenses resource.

Overview

Namelicenses
TypeResource
Idpagerduty.users.licenses

Fields

The following fields are returned by SELECT queries:

The License allocated to the User

NameDatatypeDescription
idstringUniquely identifies the resource
namestringName of the License.
descriptionstringDescription of the License. May include the names of add-ons associated with the License, if there are any.
html_urlstringHTML URL to access the License
role_groupstringIndicates whether this License is assignable to full or stakeholder Users (FullUser, Stakeholder) (example: FullUser)
selfstringAPI URL to access the License
summarystringSummary of the License
typestringType of object
valid_rolesarrayThe roles a User with this License can have

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectidGet 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.

NameDatatypeDescription
idstringThe ID of the resource.

SELECT examples

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
;