Authentication verifies the authenticity of the ID specified by a user. The positive authentication result is user authorization, i. e., Creatio grants the user permissions to resources they can use to solve their problems.
Learn more about authentication on Wikipedia.
Authenticate all external requests to Creatio web services.
Authentication types
Creatio supports the following authentication types:
- Anonymous authentication
- Basic authentication
- Cookie-based authentication (Forms authentication)
- Authentication based on the OAuth 2.0 open authorization protocol. Learn more in a separate article: Set up OAuth 2.0 authorization for integrated applications.
We recommend using Forms authentication to integrate external services with Creatio. Forms authentication is implemented via the AuthService.svc web service. Use the cookies received in response from the AuthService.svc web service in the subsequent requests to Creatio.
View examples that use authentication cookies in separate articles: OData, DataService.
Disable protection against CSRF attacks
CSRF (Cross Site Request Forgery) is a type of an attack on website visitors. CSRF attacks are based on HTTP protocol disadvantages. Protection is enabled by default, but you can disable it.
You can disable protection against CSRF attacks for the following service types:
- all Creatio services
- single Creatio service
- several methods of different Creatio services
Disable protection against CSRF attacks for all services
- Open the Web.Config file in the Creatio root directory.
-
Set the UseCsrfToken setting to false.
- Repeat the setup in the ...\Terrasoft.WebApp\Web.Config file.
Disable protection against CSRF attacks for a single service
- Open the Web.Config file in the Creatio root directory.
-
Set the service name to the DisableCsrfTokenValidationForPaths setting.
Disable protection against CSRF attacks for several methods of different services
- Open the Web.Config file in the Creatio root directory.
-
List the method names in the DisableCsrfTokenValidationForPaths setting.
Request string
Authentication service supports POST HTTP method.
Creatio application address.
To perform authentication, call the Login AuthService.svc method.
Request headers
Encoding and resource type passed in the request body.
The ForceUseSession header accounts for using the existing session.
Request body
The request body must pass the Creatio user credentials. The credentials are passed as a JSON object.
The user name of a Creatio user.
The password of a Creatio user.
HTTP status code
HTTP status code.
200 OK | The request has been completed sucessfully and the resource value is not equal to zero. In this case, the request body should contain the authentication status code. If it contains 0, the authentication is successful. In case of unsuccessful authentication, the authentication status code will equal 1 and the request body will contain a message about the cause of the unsuccessful authentication. |
---|---|
403 Forbidden | The server cannot provide access to the resource specified in the request (for example, if a method name is spelled incorrectly). Request body can contain additional information. |