private_registry_public_key
Creates, updates, deletes, gets or lists a private_registry_public_key resource.
Overview​
| Name | private_registry_public_key |
| Type | Resource |
| Id | github.private_registries.private_registry_public_key |
Fields​
The following fields are returned by SELECT queries:
- get_org_public_key
Response
| Name | Datatype | Description |
|---|---|---|
key_id | string | The identifier for the key. (example: 012345678912345678) |
key | string | The Base64 encoded public key. (example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_org_public_key | select | org | Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. |
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 |
|---|---|---|
org | string | The organization name. The name is not case sensitive. |
SELECT examples​
- get_org_public_key
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
SELECT
key_id,
key
FROM github.private_registries.private_registry_public_key
WHERE org = '{{ org }}' -- required
;