Error Codes
Setup resource
/setups
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | none | |||
| POST | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | validFrom set to a date in the past | |
| 400 | MALFORMED_PAYLOAD | Data too long for column <field name> | The length is over the maximum. |
/setups/{setupId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No current setup available | Non-existing or no currently valid setup id |
| DELETE | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| PUT | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | Entry with the same validFrom date already exists or validFrom set to a date in the past | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id | |
| 400 | MALFORMED_PAYLOAD | Data too long for column <field name> | The length is over the maximum. |
/setups/{setupId}/snapshots
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| ?validAt | 400 | MALFORMED_QUERY_PARAMETER | Invalid date format | Invalid date format |
/setups/{setupId}/snapshots/{snapshotId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id | |
| DELETE | 403 | INVALID_SNAPSHOT | Past snapshots cannot be deleted | If the valid from date of the snap shot is not in the future |
| 403 | DELETE_FORBIDDEN | Cannot delete last remaining snapshot | If the last snapshot is to be deleted | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id | |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id |
Client resource
/setups/{setupId}/clients
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| POST | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute | |
| 400 | MALFORMED_PAYLOAD | Client credentials must not be public | Grant 'client credentials' cannot be used with confidentiality 'public'. | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | validFrom set to a past date | |
| 400 | MALFORMED_PAYLOAD | Invalid client identifier | The submitted client identifier is either not unique within the setup or contains invalid characters. | |
| 400 | MALFORMED_PAYLOAD | Invalid client secret | The submitted client secret contains invalid characters. | |
| 400 | MALFORMED_PAYLOAD | Invalid scope | Non-existing scope name. | |
| 400 | MALFORMED_PAYLOAD | Invalid response type for implicit grant | The response type for the implicit grant must be "token" and "id_token". | |
| 400 | MALFORMED_PAYLOAD | Invalid response type for authorization code grant | The response type for the authorization code grant must be "token" and "id_token". | |
| 400 | MALFORMED_PAYLOAD | Data too long for the column <field name> | The length is over the maximum. |
Clients resource error codes
/setups/{setupId}/clients/{clientId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| 404 | CLIENT_NOT_FOUND | No current client available | Non-existing or no currently valid client id | |
| DELETE | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| 404 | CLIENT_NOT_FOUND | No such client available | Non-existing client id | |
| PUT | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | Entry with the same validFrom date already exists or validFrom set to a date in the past | |
| 400 | MALFORMED_PAYLOAD | Client credentials must not be public | Grant 'client credentials' cannot be used with confidentiality 'public'. | |
| 400 | MALFORMED_PAYLOAD | Client ID does not match values in database | The submitted client ID (Oauth2) does not match the values currently stored in nevisMeta. | |
| 400 | MALFORMED_PAYLOAD | Invalid client secret | The client secret contains not allowed characters. | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id | |
| 404 | CLIENT_NOT_FOUND | No such client available | Non-existing or no currently valid client id | |
| 400 | MALFORMED_PAYLOAD | Data too long for the column <field name> | The length is over the maximum. |
Client resource error codes
/setups/{setupId}/clients/{clientId}/snapshots
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| 404 | CLIENT_NOT_FOUND | No such client available | Non-existing or no currently valid client id | |
| ?validAt | 400 | MALFORMED_QUERY_PARAMETER | Invalid date format | Invalid date format |
/setups/{setupId}/clients/{clientId}/snapshots/{snapshotId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| 404 | CLIENT_NOT_FOUND | No such client available | Non-existing or no currently valid client id | |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id | |
| DELETE | 403 | INVALID_SNAPSHOT | Past snapshots cannot be deleted | If the valid from date of the snap shot is not in the future |
| 403 | DELETE_FORBIDDEN | Cannot delete last remaining snapshot | If the last snapshot is to be deleted | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id | |
| 404 | CLIENT_NOT_FOUND | No such client available | Non-existing or no currently valid client id | |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id |
Client ID translator resource
/setups/{setupId}/client-id-translator?oAuthClientId={oAuthClientId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | CLIENT_NOT_FOUND | Client not found | There is no client in a given setup whose OAuth Client ID matches with the provided client ID. |
Resource server resource
/setups/{setupId}/resource-servers
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup ID. |
| POST | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body. |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute. | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | validFrom set to a date in the past. | |
| 400 | MALFORMED_PAYLOAD | Data too long for the column <field name> | The length is over the maximum. |
/setups/{setupId}/resource-servers/{resourceServerId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| 404 | RESOURCE_SERVER_NOT_FOUND | No current resource server available | Non-existing or no currently valid resource server id | |
| DELETE | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| 404 | RESOURCE_SERVER_NOT_FOUND | No such resource server available | Non-existing resource server id | |
| PUT | 400 | MALFORMED_PAYLOAD | Invalid JSON | Incorrect JSON formatted body |
| 400 | MALFORMED_PAYLOAD | Missing attribute | Missing required attribute | |
| 400 | MALFORMED_PAYLOAD | Invalid validFrom attribute | Entry with the same validFrom date already exists or validFrom set to a date in the past | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id | |
| 404 | RESOURCE_SERVER_NOT_FOUND | No such resource server available | Non-existing or no currently valid resource server id | |
| 400 | MALFORMED_PAYLOAD | Data too long for the column <field name> | The length is over the maximum. |
setups/{setupId}/resource-servers/{resourceServerId}/snapshots
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id |
| 404 | RESOURCE_SERVER_NOT_FOUND | No such resource server available | Non-existing or no currently valid resource server id | |
| ?validAt | 400 | MALFORMED_QUERY_PARAMETER | Invalid date format | Invalid date format |
/setups/{setupId}/resource-servers/{resourceServerId}/snapshots/{snapshotId}
| Service Name | HTTP Code | Error Code | Error Text | Description |
|---|---|---|---|---|
| GET | 404 | SETUP_NOT_FOUND | No such setup available | Non-existing setup id |
| 404 | RESOURCE_SERVER_NOT_FOUND | No such resource server available | Non-existing or no currently valid resource server id | |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id | |
| DELETE | 403 | INVALID_SNAPSHOT | Past snapshots cannot be deleted | If the valid from date of the snapshot is not in the future |
| 403 | DELETE_FORBIDDEN | Cannot delete last remaining snapshot | If the last snapshot is to be deleted | |
| 404 | SETUP_NOT_FOUND | No such setup available | Non-existing or no currently valid setup id | |
| 404 | RESOURCE_SERVER_NOT_FOUND | No such resource server available | Non-existing or no currently valid resource server id | |
| 404 | SNAPSHOT_NOT_FOUND | No such snapshot available | Non-existing snapshot id |