# emqx-auth-clientid

**Repository Path**: jacky510/emqx-auth-clientid

## Basic Information

- **Project Name**: emqx-auth-clientid
- **Description**: EMQ X ClientId Authentication Plugin
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-12-22
- **Last Updated**: 2021-12-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

emqx_auth_clientid
==================

Authentication with ClientId and Password

Build
-----

```
make && make tests
```

Configuration
-------------

etc/emqx_auth_clientid.conf:

```
## Password hash.
##
## Value: plain | md5 | sha | sha256
auth.client.password_hash = sha256
```

[REST API](https://developer.emqx.io/docs/emq/v3/en/rest.html)
------------

List all clientids:

```
# Request
GET api/v4/auth_clientid

# Response
{
    "code": 0,
    "data": ["clientid1"]
}
```

Add clientid:

```
# Request
POST api/v4/auth_clientid
{
    "clientid": "a_client_id",
    "password": "password"
}

# Response
{
    "code": 0
}
```

Update password for a clientid:

```
# Request
PUT api/v4/auth_clientid/$CLIENTID

{
    "password": "password"
}

# Response
{
    "code": 0
}
```

Lookup a clientid info:

```
# Request
GET api/v4/auth_clientid/$CLIENTID

# Response
{
    "code": 0,
    "data": {
        "clientid": "a_client_id",
        "password": "hash_password" 
    }
}
```

Delete a clientid:

```
# Request
DELETE api/v4/auth_clientid/$CLIENTID

# Response
{
    "code": 0
}
```

Load the Plugin
---------------

```
./bin/emqx_ctl plugins load emqx_auth_clientid
```

License
-------

Apache License Version 2.0

Author
------

EMQ X Team.