Api Authentication

POST 
/v3/auth/app-api

This endpoint authenticates an application over the Ignisign API.
The identification is related to an environment (appEnv) and an application (appId).
The secret is used to authenticate the application.
If validated, a JWT token is returned that can be used to authenticate the application using a Bearer token.

Request

application/json

Body

appId appId (string)required

The application identifier which is used to identify the application used.

appEnv IGNISIGN_APPLICATION_ENV (string)required

Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

The execution environment of the application where request are executed.

secret stringrequired

The secret related to the application and the environment.
This secret can be obtained from the Ignisign's Console (https://console.ignisign.io)

Responses

200

OK

application/json

Schema

Schema

jwtToken stringrequired

Example (from schema)

{
  "jwtToken": "string"
}

400

Bad request error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

401

Unauthorized error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

403

Forbidden

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

404

Not Found

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

408

Timeout

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

500

Internal Error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Loading...