docs/auth.md in losant_rest-1.0.8 vs docs/auth.md in losant_rest-1.1.0
- old
+ new
@@ -13,29 +13,32 @@
<br/>
## Authenticate Device
-Authenticates a device using the provided credentials
+Authenticates a device using the provided credentials.
```ruby
result = client.auth.authenticate_device(credentials: my_credentials)
puts result
```
+#### Authentication
+No api access token is required to call this action.
+
#### Available Parameters
| Name | Type | Required | Description | Default | Example |
| ---- | ---- | -------- | ----------- | ------- | ------- |
| credentials | [Device Credentials](_schemas.md#device-credentials) | Y | Device authentication credentials | | [Device Credentials Example](_schemas.md#device-credentials-example) |
#### Successful Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
-| 200 | [Authenticated Device](_schemas.md#authenticated-device) | Successful authentication |
+| 200 | [Authenticated Device](_schemas.md#authenticated-device) | Successful authentication. The included api access token has the scope 'all.Device'. |
#### Error Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
@@ -44,23 +47,26 @@
<br/>
## Authenticate Solution User
-Authenticates a solution user using the provided credentials
+Authenticates a solution user using the provided credentials.
```ruby
result = client.auth.authenticate_solution_user(credentials: my_credentials)
puts result
```
+#### Authentication
+No api access token is required to call this action.
+
#### Available Parameters
| Name | Type | Required | Description | Default | Example |
| ---- | ---- | -------- | ----------- | ------- | ------- |
-| credentials | [User Credentials](_schemas.md#user-credentials) | Y | Solution user authentication credentials | | [User Credentials Example](_schemas.md#user-credentials-example) |
+| credentials | [User Credentials](_schemas.md#user-credentials) | Y | Solution user authentication credentials. The included api access token has the scope 'all.SolutionUser'. | | [User Credentials Example](_schemas.md#user-credentials-example) |
#### Successful Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
@@ -75,29 +81,32 @@
<br/>
## Authenticate User
-Authenticates a user using the provided credentials
+Authenticates a user using the provided credentials.
```ruby
result = client.auth.authenticate_user(credentials: my_credentials)
puts result
```
+#### Authentication
+No api access token is required to call this action.
+
#### Available Parameters
| Name | Type | Required | Description | Default | Example |
| ---- | ---- | -------- | ----------- | ------- | ------- |
| credentials | [User Credentials](_schemas.md#user-credentials) | Y | User authentication credentials | | [User Credentials Example](_schemas.md#user-credentials-example) |
#### Successful Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
-| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication. The included api access token has the scope 'all.User'. |
#### Error Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
@@ -106,28 +115,31 @@
<br/>
## Authenticate User Github
-Authenticates a user via GitHub OAuth
+Authenticates a user via GitHub OAuth.
```ruby
result = client.auth.authenticate_user_github(oauth: my_oauth)
puts result
```
+#### Authentication
+No api access token is required to call this action.
+
#### Available Parameters
| Name | Type | Required | Description | Default | Example |
| ---- | ---- | -------- | ----------- | ------- | ------- |
| oauth | [Github Login](_schemas.md#github-login) | Y | User authentication credentials (access token) | | [Github Login Example](_schemas.md#github-login-example) |
#### Successful Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
-| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication. The included api access token has the scope 'all.User'. |
#### Error Responses
| Code | Type | Description |
| ---- | ---- | ----------- |