Create or update an organization secret

PUT

/orgs/{org}/actions/secrets/{secret_name}

Creates or updates an organization secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to
use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/orgs//actions/secrets/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "encrypted_value": "c2VjcmV0",
    "key_id": "012345678912345678",
    "selected_repository_ids": [
        "1296269",
        "1296280"
    ],
    "visibility": "selected"
}'

响应示例

201 - 示例 1

{}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

org

string

必需

secret_name

string

必需

secret_name parameter

Body 参数application/json

encrypted_value

string

可选

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

正则匹配:

^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$

key_id

string

可选

ID of the key you used to encrypt the secret.

selected_repository_ids

array[string]

可选

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

visibility

enum<string>

必需

Configures the access that repositories have to the organization secret. Can be one of:
- all - All repositories in an organization can access the secret.
- private - Private repositories in an organization can access the secret.
- selected - Only specific repositories can access the secret.

枚举值:

allprivateselected

示例