Function createPermissionGrant

Parameters

• client: Client
• parameters: {
      expand?:
          | string
          | string[]
          | string & {}
          | (
              | "all"
              | "user"
              | "group"
              | "field"
              | string & {}
              | "permissions"
              | "projectRole"
          )[];
      holder?: {
          expand?: string;
          parameter?: string;
          type: string;
          value?: string;
          [key: string]: unknown;
      };
      id?: number;
      permission?: string;
      schemeId: number;
      self?: string;
  }

  • Optionalexpand?:
        | string
        | string[]
        | string & {}
        | (
            | "all"
            | "user"
            | "group"
            | "field"
            | string & {}
            | "permissions"
            | "projectRole"
        )[]

    Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:

    • permissions Returns all permission grants for each permission scheme.
    • user Returns information about the user who is granted the permission.
    • group Returns information about the group that is granted the permission.
    • projectRole Returns information about the project role granted the permission.
    • field Returns information about the custom field granted the permission.
    • all Returns all expandable information.

  • Optionalholder?: {
        expand?: string;
        parameter?: string;
        type: string;
        value?: string;
        [key: string]: unknown;
    }

    • Optionalexpand?: string

      Expand options that include additional permission holder details in the response.

    • Optionalparameter?: string

      As a group's name can change, use of value is recommended. The identifier associated withthe type value that defines the holder of the permission.

    • type: string

      The type of permission holder.

    • Optionalvalue?: string

      The identifier associated with the type value that defines the holder of the permission.

  • Optionalid?: number

    The ID of the permission granted details.

  • Optionalpermission?: string

    The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions in Get all permission schemes for more information about the built-in permissions. See the project permission and global permission module documentation for more information about custom permissions.

  • schemeId: number

    The ID of the permission scheme in which to create a new permission grant.

  • Optionalself?: string

    The URL of the permission granted details.

• Optionaloptions: RequestOptions