Authentication Management API ​

This API documentation provides various operation information related to managing authentication information on username and client ID, including viewing and creating authentication information, updating authentication passwords, and deleting authentication information.

View Username Authentication Information ​

URI ​

GET /auth_username

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X GET {api}/auth_username

Response Example ​

{
  "meta": {
    "page": 1,
    "limit": 10,
    "count": 3
  },
  "data": [
    {
      "username": "api_user2"
    },
    {
      "username": "api_user1"
    },
    {
      "username": "test"
    }
  ],
  "code": 0
}

View Specified User Name Authentication Information ​

URI ​

GET /auth_username/{username}

Parameter ​

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X GET {api}/auth_username/user1

Response Example ​

{
    "data": {
        "username": "user1"
    },
    "code": 0
}

Create Username Authentication Information ​

URI ​

POST /auth_username

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X POST -d '{"username": "user_test", "password": "password"}' {api}/auth_username

{
  "code": 0
}

Response Example ​

{
"code": 0
}

Batch Create Username Authentication Information ​

URI ​

POST /auth_username

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X POST -d '[{"username": "api_user1", "password": "password"},{"username": "api_user2", "password": "password"}]' {api}/auth_username

Response Example ​

{
  "data": {
    "api_user1": "ok",
    "api_user2": "ok"
  },
  "code": 0
}

Update Username Authentication Password ​

URI ​

PUT /auth_username/{username}

Parameter ​

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X PUT  -d '{"password": "new_password"}' {api}/auth_username/api_user1

Response Example ​

{
  "code": 0
}

Delete Username Authentication Information ​

URI ​

DELETE /auth_username/{username}

Parameter ​

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X DELETE {api}/auth_username/api_user1

Response Example ​

{
  "code": 0
}

View Client Authentication Information ​

URI ​

GET /auth_clientid

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X GET {api}/auth_clientid

Response Example ​

{
  "meta": {
    "page": 1,
    "limit": 10,
    "count": 3
  },
  "data": [
    {
      "clientid": "api_user2"
    },
    {
      "clientid": "api_user1"
    },
    {
      "clientid": "test"
    }
  ],
  "code": 0
}

View Authentication Information for Specific Client ​

URI ​

GET /auth_clientid/{clientid}

Parameter ​

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X GET {api}/auth_clientid/clientid_1

Response Example ​

{
  "data": {
     "clientid": "clientid_1"
  },
  "code": 0
}

Create Client Authentication Information ​

URI ​

POST /auth_clientid

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X POST -d '{"clientid": "test", "password": "password"}' {api}/auth_clientid

Response Example ​

{
"code": 0
}

Batch Create Client Authentication Information ​

URI ​

POST /auth_clientid

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X POST -d '[{"clientid": "test1", "password": "password"},{"clientid": "test2", "password": "password"}]' {api}/auth_clientid

Response Example ​

{
  "data": {
    "test1": "ok",
    "test2": "ok"
  },
  "code": 0
}

Update Client Authentication Password ​

URI ​

PUT /auth_clientid/{clientid}

Parameter ​

Request Message ​

Response Message ​

Request Example ​

curl -u app_id:app_secret -X PUT -d '{"password": "new_password"}' {api}/auth_clientid/test1

Response Example ​

{
  "code": 0
}

Delete Client Authentication Information ​

URI ​

DELETE /auth_clientid/{clientid}

Parameter ​

Request Message ​

None.

Response Message ​

Request Example ​

curl -u app_id:app_secret -X DELETE {api}/auth_clientid/test1

Response Example ​

{
  "code": 0
}