AxeoBIM - Cerqual specific requests API documentation version v0.4.0

https://app.axxone.fr/system_aplus/api

/cerqual/authenticate_user

post

post

Get a 3-legged access token in the context of a given user.

Get a 3-legged access token in the context of a given user.

Secured by oauth2-2legged with scopes:
  • cerqual

API supports OAuth 2.0 security policy with 2-legged context

Body

Media type: application/x-www-form-urlencoded

Type: object

Properties
  • grant_type: required(cerqual)
  • scope: (string)

    Example:

    bcf:read bcf:create bcf:write
  • email: required(string)

    Example:

    user@company.com

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • token_type: required(Bearer)
  • expires_in: required(integer)

    Example:

    3600
  • access_token: required(string)
  • refresh_token: (string)
  • state: (string)

    Only present when using a implicit grant flow. Contains the state parameter sent in the original request.

HTTP status code 400

Body

Media type: application/json

Type: object

Properties
  • error: required(string)

    Error code describing what happened.

    Example:

    invalid_request
  • error_description: required(string)

    Long error message describing what happened in a readable way.

    Example:

    The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
  • message: (string)

    Old name for error_description field. Still present for backward-compatibility.

    Example:

    The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
  • hint: (string)

    When present, provides extra help to fix common mistakes.

    Example:

    Check the `client_id` parameter

HTTP status code 401

Body

Media type: application/json

Type: object

Properties
  • error: required(string)

    Error code describing what happened.

    Example:

    invalid_request
  • error_description: required(string)

    Long error message describing what happened in a readable way.

    Example:

    The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
  • message: (string)

    Old name for error_description field. Still present for backward-compatibility.

    Example:

    The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
  • hint: (string)

    When present, provides extra help to fix common mistakes.

    Example:

    Check the `client_id` parameter

Secured by oauth2-2legged

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token. A JSON Web Token. See https://jwt.io/

HTTP status code 400

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

HTTP status code 401

Bad or expired token. This can happen if the API consumer uses a revoked or expired access token. To fix, you should re-authenticate the user.