diff options
Diffstat (limited to 'doc/api/project_job_token_scopes.md')
| -rw-r--r-- | doc/api/project_job_token_scopes.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/api/project_job_token_scopes.md b/doc/api/project_job_token_scopes.md index 4d1e013ee14..4117c8c4971 100644 --- a/doc/api/project_job_token_scopes.md +++ b/doc/api/project_job_token_scopes.md @@ -4,7 +4,7 @@ group: Pipeline Security info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project CI/CD job token scope API **(FREE)** +# Project CI/CD job token scope API **(FREE ALL)** You can read more about the [CI/CD job token](../ci/jobs/ci_job_token.md) @@ -50,7 +50,9 @@ Example response: ## Patch a project's CI/CD job token access settings -Patch the [**Allow access to this project with a CI_JOB_TOKEN** setting](../ci/jobs/ci_job_token.md#disable-the-job-token-scope-allowlist) (job token scope) of a project. +> **Allow access to this project with a CI_JOB_TOKEN** setting [renamed to **Limit access _to_ this project**](https://gitlab.com/gitlab-org/gitlab/-/issues/411406) in GitLab 16.3. + +Patch the [**Limit access _to_ this project** setting](../ci/jobs/ci_job_token.md#disable-the-job-token-scope-allowlist) (job token scope) of a project. ```plaintext PATCH /projects/:id/job_token_scope @@ -142,7 +144,7 @@ Example response: } ``` -## Create a new project to a project's CI/CD job token inbound allowlist +## Add a project to a CI/CD job token inbound allowlist Add a project to the [CI/CD job token inbound allowlist](../ci/jobs/ci_job_token.md#allow-access-to-your-project-with-a-job-token) of a project. @@ -159,16 +161,16 @@ Supported attributes: If successful, returns [`201`](rest/index.md#status-codes) and the following response attributes: -| Attribute | Type | Description | -|:--------------------|:--------|:----------------------| -| `source_project_id` | integer | The ID of the project whose CI/CD job token inbound allowlist is added to. | -| `target_project_id` | integer | The ID of the project that is added to the inbound allowlist of the source project. | +| Attribute | Type | Description | +|---------------------|---------|-------------| +| `source_project_id` | integer | ID of the project containing the CI/CD job token inbound allowlist to update. | +| `target_project_id` | integer | ID of the project that is added to the source project's inbound allowlist. | Example request: ```shell -curl --request PATCH \ - --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope" \ +curl --request POST \ + --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/allowlist" \ --header 'PRIVATE-TOKEN: <your_access_token>' \ --header 'Content-Type: application/json' \ --data '{ "target_project_id": 2 }' @@ -183,7 +185,7 @@ Example response: } ``` -## Remove a project from a project's CI/CD job token inbound allowlist +## Remove a project from a CI/CD job token inbound allowlist Remove a project from the [CI/CD job token inbound allowlist](../ci/jobs/ci_job_token.md#allow-access-to-your-project-with-a-job-token) of a project. @@ -203,7 +205,6 @@ If successful, returns [`204`](rest/index.md#status-codes) and no response body. Example request: ```shell - curl --request DELETE \ --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/allowlist/2" \ --header 'PRIVATE-TOKEN: <your_access_token>' \ |