Secret
======

A secret password used to connect to the Crayon API.

Resource definition
-------------------

.. literalinclude:: _static/Secret.json
        :language: json
	
	

+-----------------+-----------------+---------------------------------------------------------------------------------+
| Name            | Type            | Description                                                                     |
+=================+=================+=================================================================================+
| Id              | int             | Identifer of the secret                                                         |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| TenantId        | int             | Tenant this secret is valid for                                                 |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| ClientId        | string          | Identifier for the external application.                                        |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| Value           | string          | The secret password                                                             |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| Description     | string          | Description of the external application                                         |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| Expiration      | DateTimeOffset? | When the secret expires and can no longer be used                               |
+-----------------+-----------------+---------------------------------------------------------------------------------+
| TimeStamp       | DateTime        | Date and time when the secret was generated                                     |
+-----------------+-----------------+---------------------------------------------------------------------------------+


Operations on Secret
--------------------

- :doc:`/scenarios/client-get`
- :doc:`/scenarios/clients-get`