OAuth2 Client Registration¶

Note

Clients (applications which wish to connect to sheepAuth to authenticate users) need to register their applications and collect digital keys.

Note

sheepCRM admin user account required. (If you don’t have an admin account please contact us and we will configure on your behalf)

Client Name: is human readable name that will be used to show a message like “{Client Name}” wants to access your information
Client Type: choose confidential
Authorization grant type: choose Authorization code
Redirect URIs: (please provide just one) this is the callback that will retrieve an access token; it must be a valid URL and include https:// (Your website plugin or system will tell you the value to use.)
Flock: the sheepCRM database identifier (required unless the client for multiple Sheep databases).
Logo: A secure url (https) link to a square logo. This will be used as part of the login process
Security Policy: A secure url (https) link to the security policy for your application.
Terms and Conditions: A secure url (https) link to the terms and conditions for your application.
Your contact details: These details will not be made public but will be used by sheepCRM to communicate with you about your integration.

Available Scopes to request¶

read: view your profile information: first_name, last_name, photo,
write: update your profile
read_membership: view your membership information: active_member, membership_type, membership_start_date, membership_end_date
introspection: Introspect token scope

authorization optional parameters:

flock: your sheep database identifier (this is required if the client is for multiple Sheep databases)
approval_prompt: force - users are always prompted for authorization. auto - users are prompted only the first time, subsequent authorizations for the same application and scopes will be automatically accepted.

Note