Skip to main content
PATCH
/
organizations
/
{organizationName}
/
projects
/
{projectName}
/
permissions
/
{userGroupId}
Update project permission
curl --request PATCH \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/permissions/{userGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userGroupId": "<string>",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'
{
  "userGroupId": "<string>",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.credibledata.com/llms.txt

Use this file to discover all available pages before exploring further.

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_-]+$
​
userGroupId
string
required

The unique identifier of the user or group 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._-]+)$

Body

application/json

Represents a permission assignment for a user or group within a project

​
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._-]+)$
​
permission
enum<string>

The role/permission level granted to the user or group

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

Project permission updated successfully

Represents a permission assignment for a user or group within a project

​
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._-]+)$
​
permission
enum<string>

The role/permission level granted to the user or group

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