Get a role

Retrieve details about a specific user role specified by ID.

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

Go

Go

package example

import (
    context "context"

    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>",
        ),
    )
    client.Roles.Get(
        context.TODO(),
        "id",
    )
}

200

{
  "id": "<string>",
  "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 retrieve.

Response

200

application/json

Role successfully retrieved.

id · string

ID for this role.

name · string

Name of this role.

description · string

Description of this role.