Skip to main content

List workspace roles

Motivation

Return the list of roles in the workspace, using API

Functional Design

GET /api/v2/apps/{owner}/{app}/schemas/{pkg}.{workspace}/roles

If Authorization header is provided, and user has sys.Developer role, the list of all roles in the workspace is returned. Otherwise, only published roles are returned.

Headers

KeyValueDescription
AuthorizationBearer {PrincipalToken}optional
Accepttext/htmlTo get the response in HTML format (default)

Parameters

ParameterTypeDescription
ownerstringname of a user who owns the application
appstringname of an application
pkg.workspacestringidentifies a workspace

Result

CodeDescriptionBody
200OKroles in the selected format
400Bad Requesterror object

See Also