Authorize Access

Description

During initial onboarding for the Integration API, Corastone creates your OAuth client for your primary integration with the Corastone platform. If you have multiple back-office apps that need to integrate with the platform, you will need to create secondary OAuth clients. These clients are linked to the same organization and are managed by the primary OAuth client. Secondary clients usually perform a subset of tasks and, therefore, require a smaller access scope.

Endpoints

Task	How	Error Codes
Create OAuth Client	../oauth/client	AU0001 AU0002 AU0008 AU0009 GN0002
Update OAuth Client	../oauth/client	AU0001 AU0002 AU0005 AU0006 AU0008 GN0002
Reset OAuth Client Password	../oauth/client/password-reset	AU0001 AU0002 AU0005 AU0006 AU0007 AU0008 GN0002

Error Codes and Messages

Key Validations

None

Business Rule Validations

Technical Validations

Type	Code	Message
Auth (OAuth)	AU0001	The access token is invalid or missing. Please provide a valid access token issued by the OAuth server using the client credentials grant (default location is on the authorization header).
	AU0002	You do not have access to this scope: {scope}
	AU0005	OAuth client with id '{clientId}' was not found
	AU0006	OAuth client with id '{clientId}' was not found on the OAuth server. This means that the client was directly deleted from the OAuth server but a reference to it still exists on this API.
	AU0007	This action is reserved for the primary client
	AU0008	The OAuth client belongs to a different organization
	AU0009	The maximum number of OAuth clients for the current organization has been reached
Generic	GN0002	The payload you have supplied is invalid.