Skip to main content

license

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

Overview

Namelicense
TypeResource
Idpagerduty.users.license

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 (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
get_user_licenseselectidAccept, Content-TypeGet the License allocated to a User

Scoped OAuth requires: licenses.read
_get_user_licenseexecidAccept, Content-TypeGet the License allocated to a User

Scoped OAuth requires: licenses.read

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.
AcceptstringThe Accept header is used as a versioning header.
Content-Typestring

SELECT examples

Get the License allocated to a User

Scoped OAuth requires: licenses.read

SELECT
id,
name,
description,
html_url,
role_group,
self,
summary,
type,
valid_roles
FROM pagerduty.users.license
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

Get the License allocated to a User

Scoped OAuth requires: licenses.read

EXEC pagerduty.users.license._get_user_license 
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}'
;