Set app permissions

PUT

/api/v1/apps/{app_name}/permissions

curl --request PUT \
  --url https://example.com/api/v1/apps/example/permissions \
  --header 'Content-Type: application/json' \
  --data '{ "access_control_list": [ { "user_name": "example", "group_name": "example", "service_principal_name": "example", "permission_level": "CAN_READ" } ] }'

Set permissions for an app.

Parameters

Path Parameters

app_name

required

App Name

string

Request Body^required

Media typeapplication/json

AppPermissionsRequest

App permissions request model.

object

access_control_list

required

Access Control List

List of access control entries to set/update

Array<object>

AppAccessControlRequest

Request model for app access control entry.

object

user_name

Any of:

string

string

null

null

group_name

Any of:

string

string

null

null

service_principal_name

Any of:

string

string

null

null

permission_level

required

AppPermissionLevel

Permission level to grant

string

Allowed values: CAN_READ CAN_RUN CAN_MANAGE

Responses

200

Successful Response

Media typeapplication/json

AppPermissions

App permissions response model.

object

access_control_list

Access Control List

List of access control entries

Array<object>

AppAccessControl

Response model for app access control entry.

object

user_name

Any of:

string

string

null

null

group_name

Any of:

string

string

null

null

service_principal_name

Any of:

string

string

null

null

display_name

Any of:

string

string

null

null

all_permissions

All Permissions

All permissions for this principal

Array<object>

object

key

additional properties

any

object_id

Any of:

string

string

null

null

object_type

Any of:

string

string

null

null

Example^generated

{
  "access_control_list": [
    {
      "user_name": "example",
      "group_name": "example",
      "service_principal_name": "example",
      "display_name": "example",
      "all_permissions": [
        {}
      ]
    }
  ],
  "object_id": "example",
  "object_type": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}