Hermes Sentinel

https://hermes-agent.com/docs
Admin
Hermes Sentinel is an authentication and user management service for the Hermes Admin Dashboard.
Tokens:5,062
Snippets:27
Trust Score:0.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/tenants/

Source: https://hermes-agent.com/docs

Retrieves a list of all tenants.

```APIDOC
## GET /api/v1/tenants/

### Description
Retrieves a paginated list of all tenants in the system.

### Method
GET

### Endpoint
/api/v1/tenants/

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **items** (array) - A list of tenant objects.
  - **id** (string) - The tenant's unique identifier.
  - **name** (string) - The name of the tenant.
- **total** (integer) - The total number of tenants.
- **page** (integer) - The current page number.
- **size** (integer) - The number of items per page.

#### Response Example
{
  "items": [
    {
      "id": "tenant-uuid-111",
      "name": "Tenant A"
    },
    {
      "id": "tenant-uuid-222",
      "name": "Tenant B"
    }
  ],
  "total": 2,
  "page": 1,
  "size": 10
}
```

--------------------------------

### GET /api/v1/organizations/

Source: https://hermes-agent.com/docs

Retrieves a list of all organizations.

```APIDOC
## GET /api/v1/organizations/

### Description
Retrieves a paginated list of all organizations in the system.

### Method
GET

### Endpoint
/api/v1/organizations/

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **items** (array) - A list of organization objects.
  - **id** (string) - The organization's unique identifier.
  - **name** (string) - The name of the organization.
- **total** (integer) - The total number of organizations.
- **page** (integer) - The current page number.
- **size** (integer) - The number of items per page.

#### Response Example
{
  "items": [
    {
      "id": "org-uuid-abc",
      "name": "Organization X"
    },
    {
      "id": "org-uuid-def",
      "name": "Organization Y"
    }
  ],
  "total": 2,
  "page": 1,
  "size": 10
}
```

--------------------------------

### GET /

Source: https://hermes-agent.com/docs

Root endpoint, likely for basic service availability check.

```APIDOC
## GET /

### Description
Root endpoint of the API. Typically used for basic service availability checks.

### Method
GET

### Endpoint
/

### Response
#### Success Response (200)
- **message** (string) - A welcome or status message.

#### Response Example
{
  "message": "Welcome to Hermes Sentinel API"
}
```

--------------------------------

### GET /api/v1/users/all

Source: https://hermes-agent.com/docs

Retrieves a list of all users in the system.

```APIDOC
## GET /api/v1/users/all

### Description
Retrieves a paginated list of all users in the system.

### Method
GET

### Endpoint
/api/v1/users/all

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **items** (array) - A list of user objects.
  - **id** (string) - The user's unique identifier.
  - **username** (string) - The user's username.
  - **email** (string) - The user's email address.
  - **roles** (array) - A list of roles assigned to the user.
- **total** (integer) - The total number of users.
- **page** (integer) - The current page number.
- **size** (integer) - The number of items per page.

#### Response Example
{
  "items": [
    {
      "id": "user-uuid-123",
      "username": "admin",
      "email": "admin@example.com",
      "roles": ["admin", "user"]
    },
    {
      "id": "user-uuid-456",
      "username": "newuser",
      "email": "newuser@example.com",
      "roles": ["user"]
    }
  ],
  "total": 2,
  "page": 1,
  "size": 10
}
```

--------------------------------

### GET /api/v1/security/policies/session

Source: https://hermes-agent.com/docs

Retrieves the session policy settings.

```APIDOC
## GET /api/v1/security/policies/session

### Description
Retrieves the current session policy settings for the system.

### Method
GET

### Endpoint
/api/v1/security/policies/session

### Response
#### Success Response (200)
- **max_age** (integer) - The maximum age of a session in seconds.
- **idle_timeout** (integer) - The maximum time of inactivity before a session expires in seconds.

#### Response Example
{
  "max_age": 3600,
  "idle_timeout": 1800
}
```

--------------------------------

### GET /api/v1/auth/me

Source: https://hermes-agent.com/docs

Retrieves information about the currently authenticated user.

```APIDOC
## GET /api/v1/auth/me

### Description
Retrieves the profile information of the currently authenticated user.

### Method
GET

### Endpoint
/api/v1/auth/me

### Response
#### Success Response (200)
- **id** (string) - The user's unique identifier.
- **username** (string) - The user's username.
- **email** (string) - The user's email address.
- **roles** (array) - A list of roles assigned to the user.

#### Response Example
{
  "id": "user-uuid-123",
  "username": "admin",
  "email": "admin@example.com",
  "roles": ["admin", "user"]
}
```

--------------------------------

### GET /api/v1/tenants/{tenant_id}/config

Source: https://hermes-agent.com/docs

Retrieves the configuration for a specific tenant.

```APIDOC
## GET /api/v1/tenants/{tenant_id}/config

### Description
Retrieves the configuration settings for a specific tenant identified by its ID.

### Method
GET

### Endpoint
/api/v1/tenants/{tenant_id}/config

### Path Parameters
- **tenant_id** (string) - Required - The unique identifier of the tenant.

### Response
#### Success Response (200)
- **config** (object) - The tenant's configuration details.

#### Response Example
{
  "config": {
    "setting1": "value1",
    "setting2": 123
  }
}
```

--------------------------------

### GET /api/v1/security/policies/password

Source: https://hermes-agent.com/docs

Retrieves the password policy settings.

```APIDOC
## GET /api/v1/security/policies/password

### Description
Retrieves the current password policy settings for the system.

### Method
GET

### Endpoint
/api/v1/security/policies/password

### Response
#### Success Response (200)
- **min_length** (integer) - The minimum required length for passwords.
- **require_uppercase** (boolean) - Whether passwords must contain uppercase letters.
- **require_lowercase** (boolean) - Whether passwords must contain lowercase letters.
- **require_digit** (boolean) - Whether passwords must contain digits.
- **require_special** (boolean) - Whether passwords must contain special characters.

#### Response Example
{
  "min_length": 8,
  "require_uppercase": true,
  "require_lowercase": true,
  "require_digit": true,
  "require_special": false
}
```

--------------------------------

### GET /api/v1/sessions/me

Source: https://hermes-agent.com/docs

Retrieves a list of active sessions for the current user.

```APIDOC
## GET /api/v1/sessions/me

### Description
Retrieves a list of all active sessions associated with the currently authenticated user.

### Method
GET

### Endpoint
/api/v1/sessions/me

### Response
#### Success Response (200)
- **sessions** (array) - A list of session objects.
  - **session_id** (string) - The unique identifier for the session.
  - **ip_address** (string) - The IP address from which the session was initiated.
  - **user_agent** (string) - The user agent string for the client.
  - **created_at** (string) - The timestamp when the session was created.
  - **expires_at** (string) - The timestamp when the session will expire.

#### Response Example
{
  "sessions": [
    {
      "session_id": "session-uuid-abc",
      "ip_address": "192.168.1.100",
      "user_agent": "Mozilla/5.0...",
      "created_at": "2023-10-27T10:00:00Z",
      "expires_at": "2023-10-27T11:00:00Z"
    }
  ]
}
```

--------------------------------

### GET /api/v1/organizations/{org_id}

Source: https://hermes-agent.com/docs

Retrieves details for a specific organization.

```APIDOC
## GET /api/v1/organizations/{org_id}

### Description
Retrieves detailed information for a specific organization identified by its ID.

### Method
GET

### Endpoint
/api/v1/organizations/{org_id}

### Path Parameters
- **org_id** (string) - Required - The unique identifier of the organization.

### Response
#### Success Response (200)
- **id** (string) - The organization's unique identifier.
- **name** (string) - The name of the organization.
- **tenants** (array) - A list of tenants associated with this organization.

#### Response Example
{
  "id": "org-uuid-abc",
  "name": "Organization X",
  "tenants": [
    {
      "id": "tenant-uuid-111",
      "name": "Tenant A"
    }
  ]
}
```

--------------------------------

### GET /api/v1/health

Source: https://hermes-agent.com/docs

Checks the health status of the Hermes Sentinel service.

```APIDOC
## GET /api/v1/health

### Description
Provides a health check endpoint to determine if the Hermes Sentinel service is operational.

### Method
GET

### Endpoint
/api/v1/health

### Response
#### Success Response (200)
- **status** (string) - The health status of the service (e.g., "ok").

#### Response Example
{
  "status": "ok"
}
```

--------------------------------

### POST /api/v1/tenants/onboard

Source: https://hermes-agent.com/docs

Onboards a new tenant into the system.

```APIDOC
## POST /api/v1/tenants/onboard

### Description
Onboards a new tenant into the system, setting up its initial configuration.

### Method
POST

### Endpoint
/api/v1/tenants/onboard

### Request Body
- **name** (string) - Required - The name for the new tenant.

### Request Example
{
  "name": "New Tenant Name"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the tenant was onboarded.
- **tenant_id** (string) - The unique identifier of the newly onboarded tenant.

#### Response Example
{
  "message": "Tenant onboarded successfully",
  "tenant_id": "tenant-uuid-333"
}
```

--------------------------------

### POST /api/v1/organizations/onboard

Source: https://hermes-agent.com/docs

Onboards a new organization into the system.

```APIDOC
## POST /api/v1/organizations/onboard

### Description
Onboards a new organization into the system.

### Method
POST

### Endpoint
/api/v1/organizations/onboard

### Request Body
- **name** (string) - Required - The name for the new organization.

### Request Example
{
  "name": "New Organization Name"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the organization was onboarded.
- **org_id** (string) - The unique identifier of the newly onboarded organization.

#### Response Example
{
  "message": "Organization onboarded successfully",
  "org_id": "org-uuid-ghi"
}
```

--------------------------------

### POST /api/v1/users/service/add

Source: https://hermes-agent.com/docs

Creates a new service user account.

```APIDOC
## POST /api/v1/users/service/add

### Description
Creates a new service user account, typically for system integrations.

### Method
POST

### Endpoint
/api/v1/users/service/add

### Request Body
- **username** (string) - Required - The username for the new service user.
- **password** (string) - Required - The initial password for the service user.

### Request Example
{
  "username": "service_account",
  "password": "service_password"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the service user was created.
- **user_id** (string) - The unique identifier of the newly created service user.

#### Response Example
{
  "message": "Service user created successfully",
  "user_id": "service-uuid-789"
}
```

--------------------------------

### POST /api/v1/users/add

Source: https://hermes-agent.com/docs

Creates a new user account.

```APIDOC
## POST /api/v1/users/add

### Description
Creates a new user account in the system.

### Method
POST

### Endpoint
/api/v1/users/add

### Request Body
- **username** (string) - Required - The username for the new user.
- **email** (string) - Required - The email address for the new user.
- **password** (string) - Required - The initial password for the new user.
- **roles** (array) - Optional - A list of roles to assign to the new user.

### Request Example
{
  "username": "newuser",
  "email": "newuser@example.com",
  "password": "initial_password",
  "roles": ["user"]
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the user was created.
- **user_id** (string) - The unique identifier of the newly created user.

#### Response Example
{
  "message": "User created successfully",
  "user_id": "user-uuid-456"
}
```

--------------------------------

### POST /api/v1/auth/login

Source: https://hermes-agent.com/docs

Logs in a user and returns an authentication token.

```APIDOC
## POST /api/v1/auth/login

### Description
Logs in a user by providing credentials and returns an authentication token.

### Method
POST

### Endpoint
/api/v1/auth/login

### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.

### Request Example
{
  "username": "user",
  "password": "password"
}

### Response
#### Success Response (200)
- **access_token** (string) - The authentication token.
- **token_type** (string) - The type of token (e.g., Bearer).

#### Response Example
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}
```

--------------------------------

### POST /api/v1/auth/password-reset/confirm

Source: https://hermes-agent.com/docs

Confirms the password reset using a token and new password.

```APIDOC
## POST /api/v1/auth/password-reset/confirm

### Description
Confirms the password reset process by validating a token and setting a new password.

### Method
POST

### Endpoint
/api/v1/auth/password-reset/confirm

### Request Body
- **token** (string) - Required - The password reset token.
- **new_password** (string) - Required - The new password for the user.

### Request Example
{
  "token": "reset_token_string",
  "new_password": "new_secure_password"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the password has been reset.

#### Response Example
{
  "message": "Password successfully reset"
}
```

--------------------------------

### POST /api/v1/auth/validate

Source: https://hermes-agent.com/docs

Validates the provided authentication token.

```APIDOC
## POST /api/v1/auth/validate

### Description
Validates the provided authentication token to check its validity.

### Method
POST

### Endpoint
/api/v1/auth/validate

### Request Body
- **token** (string) - Required - The authentication token to validate.

### Request Example
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

### Response
#### Success Response (200)
- **valid** (boolean) - Indicates if the token is valid.

#### Response Example
{
  "valid": true
}
```

--------------------------------

### PATCH /api/v1/tenants/{tenant_id}/config

Source: https://hermes-agent.com/docs

Updates the configuration for a specific tenant.

```APIDOC
## PATCH /api/v1/tenants/{tenant_id}/config

### Description
Updates the configuration settings for a specific tenant identified by its ID.

### Method
PATCH

### Endpoint
/api/v1/tenants/{tenant_id}/config

### Path Parameters
- **tenant_id** (string) - Required - The unique identifier of the tenant.

### Request Body
- **config** (object) - Required - An object containing the configuration settings to update.

### Request Example
{
  "config": {
    "setting1": "new_value"
  }
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the tenant configuration was updated.

#### Response Example
{
  "message": "Tenant configuration updated successfully"
}
```

--------------------------------

### POST /api/v1/auth/password-reset/request

Source: https://hermes-agent.com/docs

Requests a password reset for a user's account.

```APIDOC
## POST /api/v1/auth/password-reset/request

### Description
Initiates the password reset process by sending a request for a user.

### Method
POST

### Endpoint
/api/v1/auth/password-reset/request

### Request Body
- **email** (string) - Required - The email address associated with the user's account.

### Request Example
{
  "email": "user@example.com"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the password reset request was sent.

#### Response Example
{
  "message": "Password reset email sent"
}
```

--------------------------------

### POST /api/v1/auth/refresh

Source: https://hermes-agent.com/docs

Refreshes the authentication token for the current user.

```APIDOC
## POST /api/v1/auth/refresh

### Description
Refreshes the authentication token for the current user, providing a new access token.

### Method
POST

### Endpoint
/api/v1/auth/refresh

### Request Body
- **refresh_token** (string) - Required - The refresh token.

### Request Example
{
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

### Response
#### Success Response (200)
- **access_token** (string) - The new authentication token.
- **token_type** (string) - The type of token (e.g., Bearer).

#### Response Example
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}
```

--------------------------------

### POST /api/v1/auth/logout

Source: https://hermes-agent.com/docs

Logs out the currently authenticated user.

```APIDOC
## POST /api/v1/auth/logout

### Description
Logs out the currently authenticated user by invalidating their token.

### Method
POST

### Endpoint
/api/v1/auth/logout

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating successful logout.

#### Response Example
{
  "message": "User logged out successfully"
}
```

--------------------------------

### DELETE /api/v1/users/{user_id}

Source: https://hermes-agent.com/docs

Deletes a user from the system.

```APIDOC
## DELETE /api/v1/users/{user_id}

### Description
Deletes a specific user from the system identified by their ID.

### Method
DELETE

### Endpoint
/api/v1/users/{user_id}

### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user to delete.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the user was deleted.

#### Response Example
{
  "message": "User deleted successfully"
}
```

--------------------------------

### PATCH /api/v1/auth/me

Source: https://hermes-agent.com/docs

Updates the profile information of the currently authenticated user.

```APIDOC
## PATCH /api/v1/auth/me

### Description
Updates the profile information of the currently authenticated user.

### Method
PATCH

### Endpoint
/api/v1/auth/me

### Request Body
- **email** (string) - Optional - The new email address for the user.
- **username** (string) - Optional - The new username for the user.

### Request Example
{
  "email": "new.email@example.com"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the profile was updated.

#### Response Example
{
  "message": "User profile updated successfully"
}
```

--------------------------------

### PATCH /api/v1/auth/me/password

Source: https://hermes-agent.com/docs

Changes the password for the currently authenticated user.

```APIDOC
## PATCH /api/v1/auth/me/password

### Description
Changes the password for the currently authenticated user.

### Method
PATCH

### Endpoint
/api/v1/auth/me/password

### Request Body
- **current_password** (string) - Required - The user's current password.
- **new_password** (string) - Required - The new password for the user.

### Request Example
{
  "current_password": "old_password",
  "new_password": "new_secure_password"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the password was changed.

#### Response Example
{
  "message": "Password changed successfully"
}
```

--------------------------------

### PATCH /api/v1/users/{user_id}

Source: https://hermes-agent.com/docs

Updates an existing user's information.

```APIDOC
## PATCH /api/v1/users/{user_id}

### Description
Updates the information for a specific user identified by their ID.

### Method
PATCH

### Endpoint
/api/v1/users/{user_id}

### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user to update.

### Request Body
- **email** (string) - Optional - The new email address for the user.
- **username** (string) - Optional - The new username for the user.
- **roles** (array) - Optional - A list of roles to assign to the user.

### Request Example
{
  "email": "updated.email@example.com",
  "roles": ["admin"]
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the user was updated.

#### Response Example
{
  "message": "User updated successfully"
}
```

--------------------------------

### DELETE /api/v1/sessions/{session_id}

Source: https://hermes-agent.com/docs

Revokes a specific user session.

```APIDOC
## DELETE /api/v1/sessions/{session_id}

### Description
Revokes a specific user session, effectively logging out that session.

### Method
DELETE

### Endpoint
/api/v1/sessions/{session_id}

### Path Parameters
- **session_id** (string) - Required - The unique identifier of the session to revoke.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the session was revoked.

#### Response Example
{
  "message": "Session revoked successfully"
}
```
Tokens:
Raw