Retrieve Project Permissions

GET 
/org/:orgId/permissions/project/:projectId

Retrieve Project Permissions

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

projectId stringrequired

The Project ID for which you are querying

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "response": {
    "designtime_permissions": {
      "designtime_permission_matrix": {
        "568a4ab9-f7a4-4ac2-5162-9a496453d161": [
          "project.read"
        ],
        "admin1234": [
          "project.read",
          "project.update",
          "project.delete",
          "project.publish"
        ],
        "f1edfca6-7f8a-4a4d-7952-4660580c67a2": [
          "project.read"
        ]
      },
      "permissions": [
        {
          "name": "project.read",
          "id": "project.read"
        },
        {
          "name": "project.update",
          "id": "project.update"
        },
        {
          "name": "project.delete",
          "id": "project.delete"
        },
        {
          "name": "project.publish",
          "id": "project.publish"
        }
      ],
      "users": [
        {
          "user_id": "568a4ab9-f7a4-4ac2-5162-9a496453d161",
          "auth_username": "abc",
          "name": "abc",
          "super_user": false,
          "api_super_user": false,
          "email": "abc@atscale.com"
        }
      ]
    },
    "object_properties": {
      "exclusive_access": true,
      "author_user_id": "abc",
      "object_type": "project",
      "object_id": "58e262f8-3ec6-4835-4890-60e8ab51e76b"
    },
    "admins": [
      "admin1234"
    ]
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Example

{
  "response": {
    "designtime_permissions": {
      "designtime_permission_matrix": {
        "568a4ab9-f7a4-4ac2-5162-9a496453d161": [
          "project.read"
        ],
        "admin1234": [
          "project.read",
          "project.update",
          "project.delete",
          "project.publish"
        ],
        "f1edfca6-7f8a-4a4d-7952-4660580c67a2": [
          "project.read"
        ]
      },
      "permissions": [
        {
          "name": "project.read",
          "id": "project.read"
        },
        {
          "name": "project.update",
          "id": "project.update"
        },
        {
          "name": "project.delete",
          "id": "project.delete"
        },
        {
          "name": "project.publish",
          "id": "project.publish"
        }
      ],
      "users": [
        {
          "user_id": "568a4ab9-f7a4-4ac2-5162-9a496453d161",
          "auth_username": "abc",
          "name": "abc",
          "super_user": false,
          "api_super_user": false,
          "email": "abc@atscale.com"
        }
      ]
    },
    "object_properties": {
      "exclusive_access": true,
      "author_user_id": "abc",
      "object_type": "project",
      "object_id": "58e262f8-3ec6-4835-4890-60e8ab51e76b"
    },
    "admins": [
      "admin1234"
    ]
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if calling user does not have access right for the API.

500

A server error occurred. Check the logs for more details.

503

This error will occur if Design Center APIs are not enabled.

Loading...