Cancel a User Invitation
DELETE/v4/applications/:appId/users-invitations/:userInvitationId
This endpoint allow to cancel an invitation to a user for an application.
Request
Path Parameters
The application identifier which is used to identify the application used.
The unique identifier of the user invitation
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The cancelled user invitation.
- application/json
- Schema
- Example (from schema)
Schema
A unique string identifier for the invited user. This is typically generated by the system and is read-only.
The email address of the invited user.
The application identifier which is used to identify the application used.
Possible values: [PENDING
, ACCEPTED
, DECLINED
, CANCELED
]
The current status of the invited user.
roles
object
required
Possible values: [ADMIN
, USER
, READER
]
Possible values: [ADMIN
, USER
, READER
]
Possible values: [ADMIN
, USER
, READER
]
{
"_id": "string",
"email": "string",
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"status": "PENDING",
"roles": {
"DEVELOPMENT": [
"ADMIN"
],
"STAGING": [
"ADMIN"
],
"PRODUCTION": [
"ADMIN"
]
}
}
Bad request error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Unauthorized error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Timeout
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}