Authentication

OAuth Authorization Request

The authorization endpoint is used to interact with the resource owner and obtain an authorization grant. See https://datatracker.ietf.org/doc/html/rfc6749#section-3.1 for details. At the end of the flow it will send a code value back to/via the redirecttion URL specified in the client’s config & initial request (as they need to be the same).

post/oauth/authorize

Request

Query parameters

response_typestring required

Value MUST be set to "code".

client_idstring required

The client identifier.

redirect_uristring

The URL to redirect to after authorization has been granted.

scopestring

The scope of the access request - a space separated list of Pricefx permission names. The access token is limited to the requested permissions intersected with the scope configured for the client; it carries the permissions of its user when no scope is requested and none is configured. Values which are not known permissions are ignored, but a request of which no value at all can be granted is answered with an invalid_scope error on the redirect_uri.

statestring

An opaque value used by the client to maintain state between the request and callback.

Changes

No recorded changes to this operation across all 2 revisions of this API.