カスタムリポジトリロール

この REST API を使って、カスタムリポジトリロールを操作します。

List custom repository roles in an organization

List the custom repository roles available in this organization. In order to see custom repository roles in an organization, the authenticated user must be an organization owner.

To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organization and must use an access token with admin:org repo scope. GitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

For more information on custom repository roles, see "About custom repository roles."

パラメーター

ヘッダー
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`organization_id`string必須 The unique identifier of the organization.

HTTP 応答状態コード

状態コード	説明
`200`	Response - list of custom role names

コードサンプル

get/organizations/{organization_id}/custom_roles

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/organizations/ORGANIZATION_ID/custom_roles

Response - list of custom role names

Status: 200

{
  "total_count": 2,
  "custom_roles": [
    {
      "id": 8030,
      "name": "Developer"
    },
    {
      "id": 8031,
      "name": "Designer"
    }
  ]
}