Dfns TypeScript SDK - v0.8.13
    Preparing search index...
    type ListPermissionsResponse = {
        items: (
            {
                dateCreated: string;
                dateUpdated: string;
                id: string;
                isArchived: boolean;
                isImmutable: boolean;
                name: string;
                operations: string[];
                status: "Active";
            } & {
                pendingChangeRequest?: {
                    approvalId?: string;
                    body: {
                        id: string;
                        isArchived: boolean;
                        isImmutable: boolean;
                        name: string;
                        operations: string[];
                        status: "Active";
                    };
                    dateCreated: string;
                    dateResolved?: string;
                    entityId: string;
                    id: string;
                    kind: "Permission";
                    operationKind: "Update";
                    requester: { appId?: string; tokenId?: string; userId: string };
                    status: "Applied" | "Failed" | "Pending" | "Rejected";
                };
            }
        )[];
        nextPageToken?: string;
    }
    Index

    Properties

    items: (
        {
            dateCreated: string;
            dateUpdated: string;
            id: string;
            isArchived: boolean;
            isImmutable: boolean;
            name: string;
            operations: string[];
            status: "Active";
        } & {
            pendingChangeRequest?: {
                approvalId?: string;
                body: {
                    id: string;
                    isArchived: boolean;
                    isImmutable: boolean;
                    name: string;
                    operations: string[];
                    status: "Active";
                };
                dateCreated: string;
                dateResolved?: string;
                entityId: string;
                id: string;
                kind: "Permission";
                operationKind: "Update";
                requester: { appId?: string; tokenId?: string; userId: string };
                status: "Applied" | "Failed" | "Pending" | "Rejected";
            };
        }
    )[]

    Current page items.

    Type Declaration

    • dateCreated: string
    • dateUpdated: string
    • id: string

      ID of the permission (also referred to as "role" in the dashboard).

    • isArchived: boolean

      Whether this permission has been archived (soft-deleted).

    • isImmutable: boolean

      Whether this permission is system-managed and cannot be modified.

    • name: string

      Human-readable name of the permission (role).

    • operations: string[]

      List of API operations this permission grants access to. See Permissions List for available operations.

    • status: "Active"

      Current status of the permission.

    • OptionalpendingChangeRequest?: {
          approvalId?: string;
          body: {
              id: string;
              isArchived: boolean;
              isImmutable: boolean;
              name: string;
              operations: string[];
              status: "Active";
          };
          dateCreated: string;
          dateResolved?: string;
          entityId: string;
          id: string;
          kind: "Permission";
          operationKind: "Update";
          requester: { appId?: string; tokenId?: string; userId: string };
          status: "Applied" | "Failed" | "Pending" | "Rejected";
      }
      • OptionalapprovalId?: string
      • body: {
            id: string;
            isArchived: boolean;
            isImmutable: boolean;
            name: string;
            operations: string[];
            status: "Active";
        }
        • id: string

          ID of the permission (also referred to as "role" in the dashboard).

        • isArchived: boolean

          Whether this permission has been archived (soft-deleted).

        • isImmutable: boolean

          Whether this permission is system-managed and cannot be modified.

        • name: string

          Human-readable name of the permission (role).

        • operations: string[]

          List of API operations this permission grants access to. See Permissions List for available operations.

        • status: "Active"

          Current status of the permission.

      • dateCreated: string
      • OptionaldateResolved?: string
      • entityId: string

        ID of the entity being changed.

      • id: string

        ID of the change request.

      • kind: "Permission"
      • operationKind: "Update"
      • requester: { appId?: string; tokenId?: string; userId: string }

        The user who initiated the change request.

      • status: "Applied" | "Failed" | "Pending" | "Rejected"

        Current status of the change request.

    nextPageToken?: string

    token to use as paginationToken to request the next page.