# Client Secret

#### **Table of Contents**

- [Description](#bkmrk-description)
- [Examples](#bkmrk-examples)
- [Cookbook](#bkmrk-cookbook)
- [F.A.Q.](#bkmrk-api-documentation)
- [API Documentation](#bkmrk-api-documentation)

#### **Description**

##### *Financial meaning*

It stores the data of an API key of broker, bank, API. It provides a single point of access to user data and **API** keys (third-party services) associated with customer portfolios.

##### *Platform abstraction*

**Client Secret** in the Finmars platform is information about the client's API key, which refers to:

- [client](https://docs.finmars.com/books/client-entity/page/description "Client Secret") container for client information.

#### **Examples**

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; height: 59.6px;"><thead><tr style="height: 29.8px;"><td class="align-center" style="width: 21.2157%; height: 29.8px;">User code  
</td><td style="width: 13.5876%; height: 29.8px;">Provider  
</td><td style="width: 18.9598%;">Portfolio  
</td><td class="align-center" style="width: 26.809%; height: 29.8px;">Path to Secret  
</td><td style="width: 9.77354%;">Client ID  
</td><td style="width: 9.77354%;">Notes  
</td></tr></thead><tbody><tr style="height: 29.8px;"><td style="width: 21.2157%; height: 29.8px;">client-00</td><td style="width: 13.5876%; height: 29.8px;">Bank A  
</td><td style="width: 18.9598%;">Bonds Portfolio  
</td><td style="width: 26.809%; height: 29.8px;">finmars/bank-a-access</td><td style="width: 9.77354%;">1  
</td><td style="width: 9.77354%;">-  
</td></tr></tbody></table>

- `User code`: workspace unique identifier of the client
- `Provider`: name of broker, source, bank, API
- `Portfolio`: portfolio name
- `Path to Secret`: path to the vault (with API key)
- `Notes`: custom description
- `Client ID`: ID of [client](https://docs.finmars.com/books/client-entity/page/description "Client Secret")

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

Now u can use some thing like this in workflow script:

```python
payload = kwargs.get("payload")
client = payload.get("client")
secrets = workflow.finmars.get_secrets(client, provider="exante") 

credentials = vault.get_secret(secret.path_to_secret)
```

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.