OmniAuth is a flexible authentication system utilizing Rack middleware.
OmniAuth will always return a hash of information after authenticating
with an external provider in the Rack environment under the key
This information is meant to be as normalized as possible, so the schema below will be filled to the greatest degree available given the provider upon authentication. Fields marked required will always be present.
provider (required)The provider with which the user authenticated (e.g.
uid (required)An identifier unique to the given provider, such as a Twitter user ID. Should be stored as a string.
info (required)A hash containing information about the user
name (required)The best display name known to the strategy. Usually a concatenation of first and last name, but may also be an arbitrary designator or nickname for some strategies
nicknameThe username of an authenticating user (such as your
@-namefrom Twitter or GitHub account name)
locationThe general location of the user, usually a city and state.
descriptionA short description of the authenticating user.
imageA URL representing a profile image of the authenticating user. Where possible, should be specified to a square, roughly 50x50 pixel image.
phoneThe telephone number of the authenticating user (no formatting is enforced).
urlsA hash containing key value pairs of an identifier for the website and its URL.
For instance, an entry could be
"Blog" => "http://intridea.com/blog"
credentialsIf the authenticating service provides some kind of access token or other credentials upon authentication, these are passed through here.
tokenSupplied by OAuth and OAuth 2.0 providers, the access token.
secretSupplied by OAuth providers, the access token secret.
extraContains extra information returned from the authentication provider. May be in provider-specific formats.
raw_infoA hash of all information gathered about a user in the format it was gathered.
For example, for Twitter users this is a hash representing the JSON hash returned from the Twitter API.
Casiano Rodriguez León 2015-06-18