Skip to main content

MeResponse

Describes the calling API key: its name, whether it has cross-network access, and its scopes.

key_namestring

Human-readable name of the calling API key

Example: Acme integration key
super_userboolean

True if the key has cross-network (super-user) access; then scopes is empty

Example: false
scopes object[]

Per-network scopes granted to the key (empty for a super-user key)

  • Array [
  • network_idstring

    The network this scope grants access to

    Example: 7Hb2Kp9QvL3mNx0R8tZ4
    rolestring

    Role held on this network

    Possible values: [read_only, administrator]

    Example: read_only
    network_urlstring

    Link to this network, so the key can navigate without constructing ids

    Example: https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4
  • ]
  • links object

    Top-level collection links the key can navigate from

    property name*string
    MeResponse
    {
    "key_name": "Acme integration key",
    "super_user": false,
    "scopes": [
    {
    "network_id": "7Hb2Kp9QvL3mNx0R8tZ4",
    "role": "read_only",
    "network_url": "https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4"
    }
    ],
    "links": {}
    }