Permissions

create permission

Changed on

Creates a new permission for a role on the specified account.

post/accounts/{account_id}/permissions

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

account_idinteger required

account_id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Request body

rolestring uuid required
scope'read' | 'admin' | 'observability' | 'deploy' | 'sensitive' | 'tunnel' | 'destroy' required

Response

successful

idinteger required
_typestring required
scopestring required

Changes

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed