license
Creates, updates, deletes, gets or lists a license
resource.
Overview
Name | license |
Type | Resource |
Id | pagerduty.users.license |
Fields
The following fields are returned by SELECT
queries:
- get_user_license
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 (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_user_license | select | id | Accept , Content-Type | Get the License allocated to a User Scoped OAuth requires: licenses.read |
_get_user_license | exec | id | Accept , Content-Type | Get 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.
Name | Datatype | Description |
---|---|---|
id | string | The ID of the resource. |
Accept | string | The Accept header is used as a versioning header. |
Content-Type | string |
SELECT
examples
- get_user_license
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_user_license
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 }}'
;