Optional
logger?: LoggerProtected
Readonly
apiReadonly
clientProtected
Readonly
gistProtected
Readonly
gistReadonly
idProtected
loggerProtected
Readonly
scopeAuthenticates to an identity id, acquiring the token This token must be stored on the token database. This is a generator that only has 1 step. This is because we require the caller to perform an authorisation action. The final return value is the identity ID.
Checks that the token is still valid If the access token has expired, and there is no refresh token then this will throw the ErrorProviderUnauthenticated exception If the refresh token exists but has expired then this will throw the ErrorProviderUnauthenticated exception If the refresh token exists, and is still valid, then it will attempt to refresh the token. If you pass in identityId, expect that the new token will be persisted.
Optional
identityId: IdentityIdProtected
createProtected
extractGets an array of authenticated identity ids
Gets the identity claim. GitHub identity claims are published as gists. The claimId is the gist id
Gets all IdentitySignedClaims from a given identity.
Gets connected IdentityData from following and follower connections.
Get identity data from a username.
Optional
signal?: AbortSignalGets own identity key. GitHub has user ids, but it is an implementation detail. Usernames on GitHub are changeable.
This verifies that the claim's JSON data fits our schema This does not verify whether the signature is correct
Publish an identity claim. These are published as gists.
Refreshes the token If identity is passed in, this function should update the token db
Generated using TypeDoc
Set to the unique hostname of the provider