Skip to main content

List Trusted Domains

POST 
/v2beta/instances/:instanceId/trusted-domains/search

Lists trusted domains of the instance.

The instance_id in the input message will be used in the future.

Required permissions:

  • iam.read

Request​

Path Parameters

    instanceId stringrequired

Body

required

    pagination

    object

    Pagination and sorting.

    offset uint64

    Starting point for retrieval, in combination of offset used to query a set list of objects.

    limit int64

    limit is the maximum amount of objects returned. The default is set to 100 with a maximum of 1000 in the runtime configuration. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    Asc is the sorting order. If true the list is sorted ascending, if false the list is sorted descending. The default is descending.

    sortingColumn string

    Possible values: [TRUSTED_DOMAIN_FIELD_NAME_UNSPECIFIED, TRUSTED_DOMAIN_FIELD_NAME_DOMAIN, TRUSTED_DOMAIN_FIELD_NAME_CREATION_DATE]

    Default value: TRUSTED_DOMAIN_FIELD_NAME_UNSPECIFIED

    The field the result is sorted by.

    queries

    object[]

    Criterias the client is looking for.

  • Array [

    • domainQuery

    object

    domain string

    Possible values: <= 200 characters

    method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    Defines which text equality method is used

  • ]

Responses​

The list of trusted domains.

Schema

    trustedDomain

    object[]

  • Array [

    • instanceId string
    creationDate date-time
    domain string

  • ]

    • pagination

    object

    Contains the total number of domains matching the query and the applied limit.

    totalResult uint64

    Absolute number of objects matching the query, regardless of applied limit.

    appliedLimit uint64

    Applied limit from query, defines maximum amount of objects per request, to compare if all objects are returned.

Loading...