Third-party Lookup

Retrieve the Matrix User ID of a corresponding third-party user.

Retrieve a Matrix User ID linked to a user on the third-party service, given a set of user parameters.

get/_matrix/client/v3/thirdparty/user/{protocol}

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/thirdparty/user/:protocol/get.ts
A function with typed inputs. Its response is checked against the schema.

protocolstring required

The name of the protocol.

fieldsobject

One or more custom fields that are passed to the AS to help identify the user.

The Matrix User IDs found with the given parameters.

fieldsobject required

Information used to identify this third-party location.

protocolstring required

The protocol ID that the third-party location is a part of.

useridstring required

A Matrix User ID representing a third-party user.

[
  {
    "fields": {
      "user": "jim"
    },
    "protocol": "gitter",
    "userid": "@_gitter_jim:matrix.org"
  }
]

No recorded changes to this operation across all 1 revision of this API.