Update account permissions

Update permissions for a specific account (Super Admin only)

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

x-account-id   header string

Account ID for the request

accountId   query string

ID of the account to update permissions for

Optional Parameters

Click here to view an exhaustive list of all available parameters

force   query string

If set to 'true', applies permissions to all accounts of the specified account type

Request Body

Minimum Required

[
  "string"
]

All Properties

[
  "string"
]

Try it out

Loading...

Run Code (Cmd + Enter)Reset CodeVIM Disabled

Output:

Responses

200

Description

Permissions updated successfully

null

400

Description

Bad request - invalid input or missing required parameters

{
  "error": "string",
  "status": 0,
  "message": "string"
}

401

Description

Unauthorized - not authenticated

{
  "error": "string",
  "status": 0,
  "message": "string"
}

403

Description

Forbidden - only Super Admins can update account permissions

{
  "error": "string",
  "status": 0,
  "message": "string"
}

404

Description

Account not found

{
  "error": "string",
  "status": 0,
  "message": "string"
}

500

Description

Internal server error

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/parameters/xAccountIdHeader#/components/schemas/PermissionToAccount#/components/schemas/Error

#/components/parameters/xAccountIdHeader

OpenAPI

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

TypeScript

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/PermissionToAccount

OpenAPI

type: object
properties:
  id:
    type: integer
    description: Unique identifier for the permission-to-account relationship
  accountId:
    type: string
    description: ID of the account this permission is assigned to
  permissionId:
    type: integer
    description: ID of the permission that is assigned

TypeScript

|
export interface PermissionToAccount {
  /** Unique identifier for the permission-to-account relationship */
  id?: number;
  /** ID of the account this permission is assigned to */
  accountId?: string;
  /** ID of the permission that is assigned */
  permissionId?: number;
}

#/components/schemas/Error

OpenAPI

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

TypeScript

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /permissions/route.ts

Or the swagger.yaml spec this documentation was generated from: /permissions/swagger.yaml

Authentication Required

Required Parameters

Optional Parameters

Request Body

Try it out

Responses

References

• components-parameters-xAccountIdHeader
• components-schemas-PermissionToAccount
• components-schemas-Error

Route Source Code