access_tokens

Rotate a group access token

Rotates a group access token by passing it to the API in a header.

post/api/v4/groups/{id}/access_tokens/self/rotate

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The group ID

Request body

expires_atstring date

The expiration date of the token

Example request

{
  "expires_at": "2021-01-31"
}

Response

Rotate a group access token

idinteger required
namestring required
revokedboolean required
created_atstring date-time required
descriptionstring required
user_idinteger required
last_used_atstring date-time required
last_used_ipsstring[] required

The five most recent unique IP addresses that have authenticated with this token. When the limit is reached, the oldest IP address is removed. The list updates once per minute per token.

activeboolean required
granularboolean required
expires_atstring date-time required
access_level10 | 20 | 30 | 40 | 50 required
resource_type'project' | 'group' required
resource_idinteger required
tokenstring required

Example response

{
  "id": 2,
  "name": "John Doe",
  "description": "Token to manage api",
  "scopes": [
    "api"
  ],
  "user_id": 3,
  "last_used_at": "2020-08-31T15:53:00.073Z",
  "last_used_ips": [
    "127.0.0.1",
    "127.0.0.2",
    "127.0.0.3"
  ],
  "granular_scopes": [
    {
      "access": "personal_projects",
      "permissions": [
        "read_job"
      ],
      "project_id": 3,
      "group_id": 5
    }
  ],
  "expires_at": "2020-08-31T15:53:00.073Z",
  "access_level": 40,
  "resource_type": "project",
  "resource_id": 1234
}

Changes

No recorded changes to this operation across all 5 revisions of this API.