Skip to main content
GET
/
organizations
/
{organizationName}
/
projects
/
{projectName}
/
packages
/
{packageName}
/
permissions
/
{userGroupId}
Error
A valid request URL is required to generate request examples
{
  "userGroupId": "<string>",
  "workspace": "<string>",
  "permission": "admin",
  "inheritedPermission": "admin",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
projectName
string
required

The unique identifier of the project Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
packageName
string
required

The unique identifier of the package Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
userGroupId
string
required

The resource identifier of the User or Group Permissions for this package. A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

  • For users: user:{email} or user:{userId}
  • For groups: group:{groupName}
Pattern: ^(user:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}|group:[a-zA-Z0-9._-]+)$

Query Parameters

​
isWorkspace
boolean
default:false

Whether the resource is a workspace

Response

Package permission retrieved successfully

Represents a permission assignment for a user, group, or workspace within a package

​
userGroupId
string

A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

  • For users: user:{email} or user:{userId}
  • For groups: group:{groupName}
Pattern: ^(user:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}|group:[a-zA-Z0-9._-]+)$
​
workspace
string

Set if this PackagePermission grants Package access to a workspace (not a user)

Pattern: ^[a-zA-Z0-9_-]+$
​
permission
enum<string>

The role/permission level granted to the user, group, or workspace

Available options:
admin,
modeler,
viewer
​
inheritedPermission
enum<string>

The permission level inherited from parent project or organization

Available options:
admin,
modeler,
viewer
​
message
string

Optional message or note about the permission assignment

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the permission was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the permission was last modified