Match provided people names/logins/emails to the account's GitHub organization members.

post/match/identities

Request

Base URL
{{ server_url }}/v1
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/athenian/apis/title/docs/match/identities/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

accountinteger required

User's account ID.

Example request

{
  "account": 1,
  "identities": [
    {
      "emails": [
        "eiso@athenian.co"
      ]
    },
    {
      "names": [
        "Vadim Markovtsev",
        "vmarkovtsev"
      ]
    }
  ]
}

Response

Computed identities mapping.

confidencenumber float required

Value from 0 to 1 indicating how similar are the users.

Example response

[
  {
    "from": {
      "emails": [
        "gkwillie@athenian.co"
      ]
    },
    "to": null,
    "confidence": 0.5
  },
  {
    "from": {
      "names": [
        "Vadim Markovtsev"
      ]
    },
    "to": "github.com/vmarkovtsev",
    "confidence": 1
  }
]

Changes

No recorded changes to this operation across all 90 revisions of this API.