license_history_entries
Gets or lists a license_history_entries resource.
Overview​
| Name | license_history_entries |
| Type | Resource |
| Id | gitlab.admin.license_history_entries |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the license extracted from the license data. |
name | string | Name of the licensee. |
activated_at | string | Date when the license was activated. |
block_changes_at | string | Date when licensed features will be blocked. |
company | string | Company of the licensee. |
created_at | string | Date when the license was added. |
email | string | Email of the licensee. |
expires_at | string | Date when the license expires. |
plan | string | Name of the subscription plan. |
starts_at | string | Date when the license started. |
type | string | Type of the license. |
users_in_license_count | integer | Number of paid users in the license. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | host | Fields related to entries in the license history. Generated from the GitLab GraphQL schema field Query.licenseHistoryEntries (connection of LicenseHistoryEntry nodes). |
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 |
|---|---|---|
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
SELECT examples​
- list
Fields related to entries in the license history. Generated from the GitLab GraphQL schema field Query.licenseHistoryEntries (connection of LicenseHistoryEntry nodes).
SELECT
id,
name,
activated_at,
block_changes_at,
company,
created_at,
email,
expires_at,
plan,
starts_at,
type,
users_in_license_count
FROM gitlab.admin.license_history_entries
WHERE host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;