Skip to content

OAuth/OpenID userinfo endpoint

GET
/oauth/userinfo

Returns identity information about the resource owner authenticated by the presented access token. Authentication is the standard Authorization: Bearer header — both API keys (bwp_live_/bwp_test_) and OAuth access tokens (bwp_at_) are accepted. No scope is required to call this endpoint.

Identity claims for the resource owner

object
sub
required

Stringified user id of the resource owner.

string
Example
42
tenant_id
required

Tenant the access token is scoped to.

integer
Example
7
email
required

Email address of the resource owner.

string format: email
Example
jane@example.com
name
required

firstName lastName, trimmed. Empty string when both names are missing — never null.

string
Example
Jane Doe
role
required

The user’s tenant role at the moment the request was authenticated.

string
Example
company_admin
scopes
required

The scopes carried by the presented access token.

Array<string>
Example
[
"contacts:read",
"leads:read"
]

Authentication missing, invalid, expired, or membership revoked

object