Create an External User

POST /api/0/organizations/{organization_id_or_slug}/external-users/

Link a user from an external provider to a Sentry user.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

Body Parameters

user_id (integer)
REQUIRED

The user ID in Sentry.

external_name (string)
REQUIRED

The associated name for the provider.

provider (string)
REQUIRED

The provider of the external actor.

  • github
  • github_enterprise
  • slack
  • gitlab
  • msteams
  • custom_scm
integration_id (integer)
REQUIRED

The Integration ID.

id (integer)
REQUIRED

The external actor ID.

external_id (string)

The associated user ID for provider.

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:write
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/external-users/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
{
  "externalName": "@Billybob",
  "provider": "github",
  "userId": "1",
  "integrationId": "1",
  "id": "1"
}