Create package permission

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

import requests

url = "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions"

payload = {
    "userGroupId": "<string>",
    "workspace": "<string>",
    "message": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userGroupId: '<string>',
    workspace: '<string>',
    message: '<string>',
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userGroupId' => '<string>',
    'workspace' => '<string>',
    'message' => '<string>',
    'createdAt' => '2023-11-07T05:31:56Z',
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions"

	payload := strings.NewReader("{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "userGroupId": "<string>",
  "workspace": "<string>",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

packagePermissions

Create package permission

Creates a new permission assignment for a user, group, or workspace within the package, granting them specific roles and access levels. Can also be used to request access to the package when the user doesn’t have admin or modeler permissions.

Authorization: Requires package admin or modeler permissions, unless requestPermission is true. Parameters: Use requestPermission to indicate the user is requesting access to the resource. Notification: Use notifyPeople to send email notifications to affected users.

POST

organizations

{organizationName}

projects

{projectName}

packages

{packageName}

permissions

Create package permission

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

import requests

url = "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions"

payload = {
    "userGroupId": "<string>",
    "workspace": "<string>",
    "message": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userGroupId: '<string>',
    workspace: '<string>',
    message: '<string>',
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userGroupId' => '<string>',
    'workspace' => '<string>',
    'message' => '<string>',
    'createdAt' => '2023-11-07T05:31:56Z',
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions"

	payload := strings.NewReader("{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userGroupId\": \"<string>\",\n  \"workspace\": \"<string>\",\n  \"message\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "userGroupId": "<string>",
  "workspace": "<string>",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

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_-]+$

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

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

Response

Package permission created 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

List package permissions Get package permission