Get permissions granted by role

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

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

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"
    roles "github.com/auth0/go-auth0/management/management/roles"
)

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

200

[
  {
    "resource_server_identifier": "<string>",
    "permission_name": "<string>",
    "resource_server_name": "<string>",
    "description": "<string>"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the role to list granted permissions.

Query Parameters

per_page · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

page · integer

Page index of the results to return. First page is 0.

Required range: x >= 0

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Response

200

application/json

Role permissions successfully retrieved.

object[]

object

resource_server_identifier · string

Resource server (API) identifier that this permission is for.

permission_name · string

Name of this permission.

resource_server_name · string

Resource server (API) name this permission is for.

description · string

Description of this permission.