getAllowList

This query loads the detailed information about a certain allow list.

General Pattern

query{
    getAllowList(orgID:UUID! AllowListID:UUID!){
    field_1
    field_2 {
       nested_field_1
       ...
    }
  }
}

Sample Query

query{
  getAllowList(orgID:"a1dc174d-abf4-47d3-be3c-9281c6eba456"
  allowListID:"1e827b81-6fce-4716-9900-34bbfaa7ecbb"){
    id
    filteringType
    identifierType
    startTime
    endTime
    elements{
      id
      identifierValue
    }
  }
}

Sample Response

{
  "data": {
    "getAllowList": {
      "id": "1e827b81-6fce-4716-9900-34bbfaa7ecbb",
      "filteringType": "AllowList",
      "identifierType": "ExternalUserID",
      "startTime": "2022-06-16T16:39:00Z",
      "endTime": "2022-06-16T17:39:00Z",
      "elements": [
        {
          "id": "e3e57e24-8b01-4331-8e88-53c9a49da280",
          "identifierValue": "google-oauth2|115531730523623952390"
        }
      ]
    }
  }
}

Arguments

NameTypeDescriptionRequired
orgIDUUIDThe organization ID.Yes
allowListIDUUIDThe allow list ID.Yes

Example

Get the the information details of the Allow List using organization ID and Allow List ID: