Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/actions/getCustomOidcSubClaimForRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Get the customization template for an OIDC subject claim for a repository
example: octokit.rest.actions.getCustomOidcSubClaimForRepo({ owner, repo })
route: GET /repos/{owner}/{repo}/actions/oidc/customization/sub
scope: actions
type: API method
---

# Get the customization template for an OIDC subject claim for a repository

Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.

```js
octokit.rest.actions.getCustomOidcSubClaimForRepo({
owner,
repo,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

The account owner of the repository. The name is not case sensitive.

</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository).
57 changes: 57 additions & 0 deletions docs/actions/setCustomOidcSubClaimForRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Set the customization template for an OIDC subject claim for a repository
example: octokit.rest.actions.setCustomOidcSubClaimForRepo({ owner, repo, use_default })
route: PUT /repos/{owner}/{repo}/actions/oidc/customization/sub
scope: actions
type: API method
---

# Set the customization template for an OIDC subject claim for a repository

Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.

```js
octokit.rest.actions.setCustomOidcSubClaimForRepo({
owner,
repo,
use_default,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

The account owner of the repository. The name is not case sensitive.

</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>use_default</td><td>yes</td><td>

Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.

</td></tr>
<tr><td>include_claim_keys</td><td>no</td><td>

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository).
40 changes: 40 additions & 0 deletions docs/oidc/getOidcCustomSubTemplateForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Get the customization template for an OIDC subject claim for an organization
example: octokit.rest.oidc.getOidcCustomSubTemplateForOrg({ org })
route: GET /orgs/{org}/actions/oidc/customization/sub
scope: oidc
type: API method
---

# Get the customization template for an OIDC subject claim for an organization

Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `read:org` scope to use this endpoint.
GitHub Apps must have the `organization_administration:write` permission to use this endpoint.

```js
octokit.rest.oidc.getOidcCustomSubTemplateForOrg({
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization).
46 changes: 46 additions & 0 deletions docs/oidc/updateOidcCustomSubTemplateForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Set the customization template for an OIDC subject claim for an organization
example: octokit.rest.oidc.updateOidcCustomSubTemplateForOrg({ org, include_claim_keys })
route: PUT /orgs/{org}/actions/oidc/customization/sub
scope: oidc
type: API method
---

# Set the customization template for an OIDC subject claim for an organization

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `write:org` scope to use this endpoint.
GitHub Apps must have the `admin:org` permission to use this endpoint.

```js
octokit.rest.oidc.updateOidcCustomSubTemplateForOrg({
org,
include_claim_keys,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>include_claim_keys</td><td>yes</td><td>

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization).
7 changes: 4 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@types/sinon": "^17.0.0",
"esbuild": "^0.20.0",
"fetch-mock": "npm:@gr2m/fetch-mock@^9.11.0-pull-request-644.1",
"github-openapi-graphql-query": "^4.0.0",
"github-openapi-graphql-query": "^4.3.1",
"glob": "^10.2.6",
"jest": "^29.0.0",
"lodash.camelcase": "^4.3.0",
Expand Down
Loading