diff --git a/docs/api/dids/create.md b/docs/api/numbers/create.md similarity index 100% rename from docs/api/dids/create.md rename to docs/api/numbers/create.md diff --git a/docs/api/dids/delete.md b/docs/api/numbers/delete.md similarity index 100% rename from docs/api/dids/delete.md rename to docs/api/numbers/delete.md diff --git a/docs/api/dids/get.md b/docs/api/numbers/get.md similarity index 100% rename from docs/api/dids/get.md rename to docs/api/numbers/get.md diff --git a/docs/api/dids/list.md b/docs/api/numbers/list.md similarity index 100% rename from docs/api/dids/list.md rename to docs/api/numbers/list.md diff --git a/docs/api/dids/update.md b/docs/api/numbers/update.md similarity index 100% rename from docs/api/dids/update.md rename to docs/api/numbers/update.md diff --git a/docs/api/overview.md b/docs/api/overview.md index 0295e82cc..312c8a016 100644 --- a/docs/api/overview.md +++ b/docs/api/overview.md @@ -6,7 +6,7 @@ The endpoint for the API is: ## Authentication -A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/credentials` endpoint with basic authentication. Use the information from the [User](/configuration/user) resource. +A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/token` endpoint with basic authentication. Use the information from the [User](/configuration/user) resource. > You must append the `token` to all requests as a query parameter. diff --git a/docs/api/credentials.md b/docs/api/token.md similarity index 63% rename from docs/api/credentials.md rename to docs/api/token.md index 8e12efc1f..cd84a3428 100644 --- a/docs/api/credentials.md +++ b/docs/api/token.md @@ -2,7 +2,7 @@ This method gets a token for subsequent API calls. **URL** - `/credentials` + `/token` **Method** @@ -23,13 +23,17 @@ This method gets a token for subsequent API calls. **Sample Call** ```json -GET /api/{apiversion}/credentials +GET /api/{apiversion}/token { } HTTP/1.1 200 OK -"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.O7hC-ta225epRQlJZO44WC-l2cWohKnJ8lkmlOQpw8Z_xYiwJ6-qDUhHeJEZH9DmwIwz_jD77sj1kQUkXHsbOg" +{ + "status": 200, + "message": "Successful request", + "result": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.TZZ4kp5xIdYzs5RRt6_qVxJcOiLdk1IEHFMBSZ7SRENx6kyVhwfAlm-oeM4L2XFIr4evlTCxKEIKc0fZKwPcjw" +} ``` **Notes** diff --git a/mkdocs.yml b/mkdocs.yml index a99bb6ed4..d38812576 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,7 @@ nav: - Web Console: administration/webconsole.md - Rest API: - Overview: api/overview.md - - Credentials: api/credentials.md + - Credentials: api/token.md - Location: - create: api/location/create.md - delete: api/location/delete.md