@procivis/react-native-one-core
    Preparing search index...

    Interface CredentialListQuery

    interface CredentialListQuery {
        createdDateAfter?: string;
        createdDateBefore?: string;
        credentialSchemaIds?: string[];
        exact?: NAME[];
        ids?: string[];
        include?: CredentialListIncludeEntityType[];
        issuanceDateAfter?: string;
        issuanceDateBefore?: string;
        lastModifiedAfter?: string;
        lastModifiedBefore?: string;
        name?: string;
        organisationId: string;
        page: number;
        pageSize: number;
        profiles?: string[];
        revocationDateAfter?: string;
        revocationDateBefore?: string;
        roles?: CredentialRole[];
        searchText?: string;
        searchType?: CredentialListQuerySearchType[];
        sort?: SortableCredentialColumn;
        sortDirection?: SortDirection;
        states?: CredentialState[];
    }
    Index

    Properties

    createdDateAfter? createdDateBefore? credentialSchemaIds? exact? ids? include? issuanceDateAfter? issuanceDateBefore? lastModifiedAfter? lastModifiedBefore? name? organisationId page pageSize profiles? revocationDateAfter? revocationDateBefore? roles? searchText? searchType? sort? sortDirection? states?

    Properties

    createdDateAfter?: string

    Return only credentials created after this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    createdDateBefore?: string

    Return only credentials created before this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    credentialSchemaIds?: string[]

    Return only credentials with the specified credential schema(s).

    exact?: NAME[]

    Set which filters apply in an exact way.

    ids?: string[]

    Filter by one or more UUIDs.

    include?: CredentialListIncludeEntityType[]

    Additional fields to include in response objects. Omitting this keeps responses shorter.

    issuanceDateAfter?: string

    Return only credentials issued after this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    issuanceDateBefore?: string

    Return only credentials issued before this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    lastModifiedAfter?: string

    Return only credentials last modified after this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    lastModifiedBefore?: string

    Return only credentials last modified before this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    name?: string

    Return only credentials with a name starting with this string.

    organisationId: string

    Specifies the organizational context for this operation.

    page

    page: number

    Page number to retrieve (0-based indexing).

    pageSize: number

    Number of items to return per page.

    profiles?: string[]

    Filter by one or more country profiles.

    revocationDateAfter?: string

    Return only credentials revoked after this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    revocationDateBefore?: string

    Return only credentials revoked before this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

    roles?: CredentialRole[]

    Filter credentials by one or more roles: issued by the system, verified by the system, or held by the system as a wallet.

    searchText?: string

    Search for a string.

    searchType?: CredentialListQuerySearchType[]

    Changes where searchText is searched. Choose one or more searchTypes and pass a searchText.

    sort?: SortableCredentialColumn

    Field value to sort results by.

    sortDirection?: SortDirection

    Direction to sort results by.

    states?: CredentialState[]

    Filter by one or more credential states.

    Settings

    Member Visibility

    On This Page

    Properties