6 Administration

6.1 Deployment

The deployment of ApiFest Mapping Server and ApiFest OAuth 2.0 Server for development and simple test goals is described in the corresponding chapters - 3.1 and 4.1. The deployment for stress tests environment and production environment requires increasing the file descriotors of the OS so the servers can handle more connections. It's recommended to start several nodes of ApiFest Mapping Server and ApiFest OAuth 2.0 Server and set a load balancer in front of them.

6.2 ApiFest Mapping Server administration services

This chapter covers all available administration services exposed by the ApiFest Mapping Server.
The following table summarizes all available administration services. Follow the link in order to get more details about a service.

service	description	link
GET/apifest-mappings	Returns all the mappings loaded in the ApiFest Mapping Server.	6.2.1
GET/apifest-global-errors	Returns all custom global errors loaded in the ApiFest Mapping Server.	6.2.2
GET/apifest-reload	Reloads online mappings and global-errors configurations.	6.2.3

6.2.1 Check current loaded mappings

You can check the current mappings loaded in the ApiFest Mapping Server by the following request:
GET /apifest-mappings
The response is in JSON format.

Here is an example response:

6.2.2 Check current loaded custom global errors

You can check the current custom global errors loaded in the ApiFest Mapping Server by the following request:
GET /apifest-global-errors
The response is in JSON format.

Here is an example response:

6.2.3 Online configuration reload

In order to reload ApiFest mappings and custom global errors configuration online, you can use the following request:
GET /apifest-reload
The response is in JSON format.

If the configuration is reloaded successfully, the response body is empty. Otherwise, a response in the following format is returned:

6.3 ApiFest Oauth 2.0 Server administration services

This chapter covers all available administration services exposed by the ApiFest OAuth 2.0 Server.
 All administration services should be secured and accessible only internally (for instance, by your Sys Admins or the personnel that should administrate ApiFest client applications).
The following table summarizes all available administration services. Follow the link in order to get more details about a service.

service	description	link
POST /oauth20/scopes	Registers a new scope.	6.3.1.1
GET /oauth20/scopes	Lists all registered scopes.	6.3.1.2
GET/oauth20/scopes/[scope]	Returns details about a specific scope.	6.3.1.3
PUT /oauth20/scopes/[scope]	Updates a scope.	6.3.1.4
DELETE /oauth20/scopes/[scope]	Deletes a scope.	6.3.1.5
POST/oauth20/applications	Registers a new client application.	6.3.2.1
GET/oauth20/applications	Lists all registered client applications.	6.3.2.3
GET/oauth20/applications/[client_id]	Returns details about a specific client application.	??
PUT/oauth20/applications/[client_id]	Updates a client application.	6.3.2.5
POST/oauth20/tokens/revoke	Revokes an access token.	6.3.3
GET/oauth20/tokens/validate	Validates an access token.	6.3.4

6.3.1 Scope services

This chapter describes all available services in the ApiFest OAuth 2.0 Server related to scopes.

6.3.1.1 Register a scope

In order to register a scope, use the following service:
Below is an example request/response.
Request:
Response:
You can see more details in chapter 4.3.

6.3.1.2 List all registered scopes

In order to list all registered scopes, use the following service:
GET /oauth20/scopes

Below is an example request/response.
Request:
Response:

6.3.1.3 Get details about a scope

In order to get the details about a scope, you can use the following service:
GET /oauth20/scopes/[scope]
where scope is the name of the scope.

Below is an example request/response.
Request:
Response:

6.3.1.4 Update a scope

In order to update a scope, you can use the following service:
Below is an example request/response.
Request:
Response:

6.3.1.5 Delete a scope

In order to delete a scope, you can use the following service:
DELETE /oauth20/scopes/[scope]
where scope is the name of the registered scope.

Below is an example request/response.
Request:
Response:
 You cannot delete a scope if it is assigned to an active client application.

If you try to delete a scope that is assigned to a client application, then the following response will be returned:

6.3.2 Client application services

This chapter describes all available services in the ApiFest OAuth 2.0 Server related to client applications.

6.3.2.1 Register a client application

In order to register a client application, you can use the following service:
Below is an example request/response.
Request:
Response:
 Note, a predefined client_id and client_secret could be passed to the service so the registered client application will use them. That could be used for migration purposes. The pattern for client_id is [a-f[0-9]]+ as the client_id is a hash value, it can contain only letters from a to f and digits.

Below is an example request/response.
Request:
Response:

6.3.2.2 Activate/Deactivate a client application

By default, when a client application is registered its status is inactive and it couldn't be used.
In order to activate a client application, use the following request:
where client_id is the client id of the client application and status is the new status of the client application - 0 - means the client application is deactivated, 1 - the client application is activated.

Below is an example request/response.
Request: where status 1 is active, 0 - inactive.

Response:

6.3.2.3 List all registered client applications

You can list all registered client applications by using the following service:
Below is an example request/response.
Request:
Response:

6.3.2.4 List all active/inactive client applications

You can list all client applications filtered by their status (active or inactive) using a query parameter to the service for listing client applications.
where status is the status of the client application - 0 - inactive, 1 - active.

Here is an example request/response that lists all active client applications.
Request:
Response:
Here is an example request/response that lists all inactive client applications.
Request:
Response:

6.3.2.5 Update a client application

A registered client application details could be updated using the following request:
where client_id is the client id of the client application.

Here is an example request/response.
Request:
Response:
You can update only the description, the scope, the application details and the status of a client application.

6.3.3 Access token revocation

An access token could be revoked using the following service:
where access_token is the access token to be revoked, client_id is the client id of the client application the access token is issued for.

Here is an example request/response.
Request:
Response:

6.3.4 Access token validation

One can check whether an access token is valid or not, using the following service:

Here is an example request/response.
Request:
Response:
Here is an example request/response when the access token is invalid (expired or never issued).
Request:
Response: