Skip to main content
POST
/
organizations
/
{organizationName}
/
projects
/
{projectName}
/
packages
/
{packageName}
/
permissions
{
  "userGroupId": "<string>",
  "workspace": "<string>",
  "permission": "admin",
  "inheritedPermission": "admin",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
organizationName
string
required

The unique identifier of the organization

​
projectName
string
required

The unique identifier of the project

​
packageName
string
required

The unique identifier of the package

Query Parameters

​
requestPermission
boolean
default:false

Indicates that the user is requesting access to the resource

​
notifyPeople
boolean
default:false

Whether to notify people when permissions are granted

Body

application/json

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

​
userGroupId
string

User or group identifier pattern (user must be valid email address, group is standard identifier)

​
workspace
string

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

​
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

Response

Package permission created successfully

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

​
userGroupId
string

User or group identifier pattern (user must be valid email address, group is standard identifier)

​
workspace
string

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

​
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

⌘I