ロールの取得

テナント内で作成されたユーザーロールの詳細一覧を取得します。

注: 返される一覧には、Admin や Support Access など、テナントメンバーが利用できる標準ロールは含まれません。

GET https://{tenantDomain}/api/v2/roles

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListRolesRequestParameters{
        PerPage: management.Int(
            1,
        ),
        Page: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        NameFilter: management.String(
            "name_filter",
        ),
    }
    client.Roles.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "description": "<string>",
    "id": "<string>",
    "name": "<string>"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

per_page · integer

1 ページあたりの結果数です。既定値は 50 です。

必須範囲: 1 <= x <= 100

page · integer

返される結果のページインデックスです。最初のページは 0 です。

必須範囲: x >= 0

include_totals · boolean

結果の総数を含むオブジェクトとして返すか（true）、結果の配列をそのまま返すか（false、既定値）を指定します。

name_filter · string

name に対するオプションのフィルターです（大文字と小文字は区別されません）。

レスポンス

200

application/json

ロールを正常に取得しました。

object[]

object

description · string

このロールの説明。

id · string

このロールの ID。

name · string

このロールの名前。