Skip to content

Update Configure Authentication.adoc #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
serversonic wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Configure Authentication.adoc #688

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions content/developer/api/Developer-setup-guide/Configure Authentication.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ image:Admin-OAuth2Clients-2.png[Create a new Client]
| Field| Description
|*Name* |This makes it easy to identify the client.
|*Secret* |Defines the *client_secret* which is posted to the server
during authentication.
during authentication. This is the value of oauth2_encryption_key in `config.php`.
|*Is Confidential* |A confidential client is an application that is
capable of keeping a client password confidential to the world.
|*Associated User* |Limits the client access to CRM, by associating the client with the security privileges of a user.
Expand All @@ -56,6 +56,8 @@ The 'secret' will be hashed when saved, and will not be accessible
later. The 'id' is created by SuiteCRM and will be visible once the
client is saved.

When the Oauth2 client has been saved, the entry has to be edited and the value of client_secret entered in the Change Secret field.

image:Admin-OAuth2Clients-5.png[View a Client Credentials Client]

== Authentication with Client Credentials
Expand Down Expand Up @@ -304,4 +306,4 @@ this in the HTTP headers, each time you make a request to the API

|*refresh_token* |an encrypted payload that can be used to refresh the
access token when it expires.
|=======================================================================
|=======================================================================