Concepts
Quickstarts
Tutorials
APIs

Introduction Authorization Query Syntax Rate Limits Errors Resources

List All Clients Create Client Get Client Update Client Delete Client

List Connections Create Connection Get Connection Update Connection Delete Connection

List Custom Domains Create Custom Domain Get Custom Domain Delete Custom Domain Verify Custom Domain Ownership

List All Hooks Create Hook Get Hook Update Hook Delete Hook

Get Keys Rotate Keys Revoke Key

List MFAs Create MFA Get MFA Update MFA Delete MFA

Get Email Provider Update Email Provider Settings

List All Resources Create Resource Get Resource Update Resource Delete Resource Get Authorized Clients Of Resource Authorize Clients To Resource Unauthorize Client From Resource Get Authorized Permissions Of Resource To Client Authorize Permissions For Client Unauthorize Permissions From Client

Get Resource Permissions Create Permission Delete Permission

List Role Groups Create Role Group Get Role Group Update Role Group Delete Role Group Get Roles Assigned To Role Group Add Roles To Role Group Unassign Roles From Role Group Get Users Assigned To Role Group

List Roles Create Role Get Role Update Role Delete Role Get Permissions Assigned to Role Assign Permissions To Role Unassign Permissions From Role Get Users Assigned to Role

Get Template Update Template Reset Template to Default

Create Tenant Delete Tenant Invite Administrator Get Administrators Remove Administrator Assign Permissions to Administrator Unassign Permissions from Administrator Get Tenant Stats Get Tenant Settings Update Tenant Settings

Create Reset Password Ticket Create Email Verification Ticket

List All Users Create User Get User Update User Delete User Get User RBAC Tree Get Created Tenants

Get Directly Assigned Permissions Of User Directly Assign Permissions To User Unassign Directly Assigned Permissions From User

Get Assigned Role Groups Of User Assign Role Groups To User Unassign Role Groups From User

Get Directly Assigned Roles Of User Directly Assign Role To User Unassign Directly Assigned Roles From User

Get Sessions Of User Revoke All Sessions Of User Revoke User Session

Remove User Credential

Get View Update View

List Roles

Scopes

read:role

Query Parameters

offset
integer

min0

max

99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

limit
integer

min-1

max

500

Limit the number of results returned

sort_by
string

Properties that should be ordered by with their order type. To define order append it to the field with dot. For example: sort_by=email.asc or sort_by=email.desc

q
string

Additional query in PlusAuth Query Language format.

GET

/roles

1

2

3

Loading...

Response:

200

Loading...

Response Body Schema

results
array<object>

results.
assign_on_signup
boolean

If true this role will be assigned to new users automatically.

results.
description
string

Additional information for the role

results.
id
string
REQUIRED

Unique identifier of entity

results.
name
string
REQUIRED

A name defining your role

total
integer

Platform

Authentication
Authorization
User Management
Monitoring

Core Features

Single Sign-On
Passwordless Login
Multi-Factor Authentication
Attack Protection

Extensibility

Hooks
Views
Email & SMS
Domain

Industries

Financial Services
Healthcare
Public Sector
Retail
Tech & SaaS

Resources

Concepts
Quickstarts
Tutorials
APIs

Support

Blog
Forum

Company

About Us
Compliance
Partners

[email protected]

© 2024 PlusAuth. All rights reserved.

End User Agreement|Terms of Notice|Privacy Notice