# Access


This API provides essential endpoints for user information and authentication, crucial for accessing and utilising any subsequent products. 

The authentication endpoint ensures secure access to the main API. 

The user endpoints return comprehensive details about logged-in users within the customer's environment and provide higher-level 
user information. 

Additionally, the API allows users to view their subscriptions for available products and the languages that are supported.

{% admonition type="info" name="OAS 3.0.4 Trial Availability" %}
The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.
{% /admonition %}


Version: 1.0.0
Metadata:
  - tags: ["Authentication"]

## Servers

Sandbox server
```
https://connect.sandbox.creditsafe.com/v1
```

Production server
```
https://connect.creditsafe.com/v1
```

## Security

### bearerToken

This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Access](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/Access/@OAS3.1/access.yaml)

## Authentication

Endpoints for user authentication into the Connect API.

### Authenticate

 - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/access/access/authentication/authenticate.md): Supply username and password to generate Authentication Token.
  


## User Administration

Endpoints for user management.

### Subscription Details

 - [GET /access](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/access/access/user-administration/subscriptiondetails.md): Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring.

### List of Active Users

 - [GET /access/users/active](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetactivecustomerusers.md): Returns a collection of user details with in the customer

### Logged In User Details

 - [GET /access/users/me](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetdetailsofloggedinuser.md): Returns the details of logged in user.