# User

## The user object

### Attributes

**id** `integer`\
Unique identifier for the object.

**email** `string`\
The user's email.

**first\_name**`string`\
The user's first name.

**last\_name**`string`\
The user's last name.

**company** `hash`\
The user's company.\
\
    company.**id** `integer`\
    Unique identifier for the company object.\
\
    company.**name** `string`\
    The company's name.\
\
    company.**products** `array of hashes`\
    The Redflag products, company authorized to use.\
\
        company.products\[].**uid** `string`\
        Unique identifies of the offered Redflag product.\
\
        company.products\[].**active** `boolean`\
        Whether the product is available for usage.

{% tabs %}
{% tab title="JSON EXAMPLE" %}

```javascript
{
    "id": 1783,
    "email": "staginguser@examplecompany.com",
    "first_name": "API",
    "last_name": "Staging",
    "company": {
        "id": 132,
        "name": "Example Company",
        "products": [
            {
                "uid": "api",
                "active": true
            }
        ]
    }
}
```

{% endtab %}
{% endtabs %}

## Sign in a user

This is the only unprotected route and required in order to obtain JWT Token before making any other requests.

### Request

{% tabs %}
{% tab title="ENDPOINT" %}

```erlang
[POST] /api/v1/users/sign_in
```

{% endtab %}
{% endtabs %}

#### **Payload**

**user** `hash`\
 \
    user.**email** `string`\
    Your company's user email.\
\
    user.**password** `string`\
    Your company's user password.

{% tabs %}
{% tab title="JSON EXAMPLE" %}

```javascript
{
	"user": {
		"email": "staginguser@examplecompany.com",
		"password": "wkfbwekfb23"
	}
}
```

{% endtab %}
{% endtabs %}

#### Example

```bash
curl -i -X POST 'https://product-api.redflagai.co/api/v1/users/sign_in' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
	"user": {
		"email": "staginguser@examplecompany.com",
		"password": "wkfbwekfb23"
	}
}'
```

### Response

The [user](/resources/user.md#the-user-object) object.

{% hint style="warning" %}
The JWT Token can be located under `Authorization` HTTP Header. Make sure to keep it secure.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.redflagai.co/resources/user.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.