Skip to content

Variable: PermissionCheckResponseSchema ​

ts
const PermissionCheckResponseSchema: ZodObject<{
  _links: ZodOptional<ZodObject<{
     base: ZodOptional<ZodString>;
     byOperation: ZodOptional<ZodString>;
     collection: ZodOptional<ZodString>;
     context: ZodOptional<ZodString>;
     download: ZodOptional<ZodString>;
     editui: ZodOptional<ZodString>;
     edituiv2: ZodOptional<ZodString>;
     next: ZodOptional<ZodString>;
     prev: ZodOptional<ZodString>;
     self: ZodOptional<ZodString>;
     tinyui: ZodOptional<ZodString>;
     webui: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  errors: ZodOptional<ZodArray<ZodObject<{
     args: ZodArray<ZodUnion<readonly [ZodString, ZodRecord<ZodString, ZodAny>]>>;
     key: ZodOptional<ZodString>;
     translation: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>>;
  hasPermission: ZodBoolean;
}, ApiObjectConfig<undefined>>;

Defined in: src/v1/models/permissionCheckResponse.ts:19

This object represents the response for the content permission check API. If the user or group does not have permissions, the following errors may be returned:

  • Group does not have permission to the space
  • Group does not have permission to the content
  • User is not allowed to use Confluence
  • User does not have permission to the space
  • User does not have permission to the content
  • Anonymous users are not allowed to use Confluence
  • Anonymous user does not have permission to the space
  • Anonymous user does not have permission to the content