providers - Documentation

# providers

## User. providers

### Methods

#### (route) add()

##### Route:

Method | Path
--- | ---
POST | /api/users/integrations

Add providers for a user

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Description
--- | --- | ---
name | String | the provider name

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Response Code:

Type | Description
--- | ---
400 | invalid parameters
403 | the user already have this provider
200 | succesfully added the provider

#### (route) remove(:name)

##### Route:

Method | Path
--- | ---
DELETE | /api/users/integrations/:name

Revove a provider for the user

##### Authentication

A authentication is needed to access this endpoint

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:name | String | the provider name

##### Response Code:

Type | Description
--- | ---
400 | invalid parameters or provider isn't implemented
403 | the provider isn't enabled
200 | succesfully removed the provider

##### Parameters:

Name | Type | Description
--- | --- | ---
`:name` |  | the provider name

#### (route) retrieve()

##### Route:

Method | Path
--- | ---
GET | /api/users/integrations

List providers for a user

##### Authentication

A authentication is needed to access this endpoint

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Response:

Name | Type | Description
--- | --- | ---
. | Array | array of providers for user account

##### Response Code:

Type | Description
--- | ---
200 | succesfully retrieved providers