Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
38 changes: 38 additions & 0 deletions backends/pelioncloud_devicemanagement/docs/AccessKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

# AccessKey

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountId** | **String** | The ID of the account. | [optional]
**applicationId** | **String** | The ID of the application. | [optional]
**createdAt** | [**DateTime**](DateTime.md) | Creation UTC time RFC3339. | [optional]
**description** | **String** | The description of the access key. | [optional]
**etag** | **String** | API resource entity version. | [optional]
**expiration** | [**DateTime**](DateTime.md) | Expiration time of the access key, as UTC time RFC3339. Expiration makes the access key inoperative and the status will be EXPIRED. The client using the expired access key is no longer able to use the REST API. The access key expiration does not invalidate existing configurations meaning that subscribed events will continue to flow on existing channels. | [optional]
**id** | **String** | The ID of the access key. | [optional]
**key** | **String** | The access key. The full key including the secret part is visible in the response for create only | [optional]
**lastUsedAt** | [**DateTime**](DateTime.md) | The time of the latest access key usage. | [optional]
**name** | **String** | The display name for the access key. |
**object** | [**ObjectEnum**](#ObjectEnum) | Entity name: always 'access-key' | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the access key. ACTIVE means that the access key is operational. INACTIVE means that the access key is not operational and it prevents the clients to use the REST API. Inactivating the access key does not invalidate existing configurations meaning that subscribed events will continue to flow on existing channels. The EXPIRED status is not allowed to be set directly, it is derived from the expiration attribute. | [optional]
**updatedAt** | [**DateTime**](DateTime.md) | Last update UTC time RFC3339. | [optional]


<a name="ObjectEnum"></a>
## Enum: ObjectEnum
Name | Value
---- | -----
KEY | &quot;access-key&quot;


<a name="StatusEnum"></a>
## Enum: StatusEnum
Name | Value
---- | -----
ACTIVE | &quot;ACTIVE&quot;
INACTIVE | &quot;INACTIVE&quot;
EXPIRED | &quot;EXPIRED&quot;



31 changes: 31 additions & 0 deletions backends/pelioncloud_devicemanagement/docs/AccessKeyList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

# AccessKeyList

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**after** | **String** | The entity ID to retrieve after the given one. | [optional]
**data** | [**List&lt;AccessKey&gt;**](AccessKey.md) | A list of entities. |
**hasMore** | **Boolean** | Flag indicating whether there are more results. |
**limit** | **Integer** | The number of results to return, or equal to &#x60;total_count&#x60;. |
**object** | [**ObjectEnum**](#ObjectEnum) | Entity name: always &#x60;list&#x60;. |
**order** | [**OrderEnum**](#OrderEnum) | The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC. | [optional]
**totalCount** | **Integer** | The total number of records, if requested. |


<a name="ObjectEnum"></a>
## Enum: ObjectEnum
Name | Value
---- | -----
LIST | &quot;list&quot;


<a name="OrderEnum"></a>
## Enum: OrderEnum
Name | Value
---- | -----
ASC | &quot;ASC&quot;
DESC | &quot;DESC&quot;



130 changes: 130 additions & 0 deletions backends/pelioncloud_devicemanagement/docs/AccountAccessKeysApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# AccountAccessKeysApi

All URIs are relative to *https://api.us-east-1.mbedcloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getAccessKey**](AccountAccessKeysApi.md#getAccessKey) | **GET** v3/access-keys/{access_key_id} | Get access key.
[**getAllAccessKeys**](AccountAccessKeysApi.md#getAllAccessKeys) | **GET** v3/access-keys | Get all access keys.


<a name="getAccessKey"></a>
# **getAccessKey**
> AccessKey getAccessKey(accessKeyId)

Get access key.

Retrieve details of an access key. &lt;b&gt;Note:&lt;/b&gt; This endpoint is restricted to administrators. **Example:** &#x60;&#x60;&#x60; curl -X GET https://api.us-east-1.mbedcloud.com/v3/access-keys/{access_key_id} \\ -H &#39;Authorization: Bearer &lt;access_key&gt;&#39; &#x60;&#x60;&#x60;

### Example
```java
// Import classes:
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.ApiClient;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.ApiException;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.Configuration;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.auth.*;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.api.AccountAccessKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

AccountAccessKeysApi apiInstance = new AccountAccessKeysApi();
String accessKeyId = "accessKeyId_example"; // String | The ID of the access key to retrieve.
try {
AccessKey result = apiInstance.getAccessKey(accessKeyId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessKeysApi#getAccessKey");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**accessKeyId** | **String**| The ID of the access key to retrieve. |

### Return type

[**AccessKey**](AccessKey.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getAllAccessKeys"></a>
# **getAllAccessKeys**
> AccessKeyList getAllAccessKeys(limit, after, order, include, statusEq, applicationIdEq)

Get all access keys.

Retrieve an array of access keys. &lt;b&gt;Note:&lt;/b&gt; This endpoint is restricted to administrators. **Example:** &#x60;&#x60;&#x60; curl -X GET https://api.us-east-1.mbedcloud.com/v3/access-keys \\ -H &#39;Authorization: Bearer &lt;access_key&gt;&#39; &#x60;&#x60;&#x60;

### Example
```java
// Import classes:
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.ApiClient;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.ApiException;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.Configuration;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.auth.*;
//import com.arm.mbed.cloud.sdk.lowlevel.pelionclouddevicemanagement.api.AccountAccessKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

AccountAccessKeysApi apiInstance = new AccountAccessKeysApi();
Integer limit = 50; // Integer | The number of results to return (2-1000). Default 50.
String after = "after_example"; // String | The entity ID to retrieve after the given one.
String order = "ASC"; // String | Record order based on creation. Acceptable values: ASC, DESC. Default: ASC.
String include = "include_example"; // String | Comma-separated additional data to return. Currently supported: total_count.
String statusEq = "statusEq_example"; // String | Status filter.
String applicationIdEq = "applicationIdEq_example"; // String | Application filter.
try {
AccessKeyList result = apiInstance.getAllAccessKeys(limit, after, order, include, statusEq, applicationIdEq);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessKeysApi#getAllAccessKeys");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| The number of results to return (2-1000). Default 50. | [optional] [default to 50]
**after** | **String**| The entity ID to retrieve after the given one. | [optional]
**order** | **String**| Record order based on creation. Acceptable values: ASC, DESC. Default: ASC. | [optional] [default to ASC]
**include** | **String**| Comma-separated additional data to return. Currently supported: total_count. | [optional]
**statusEq** | **String**| Status filter. | [optional]
**applicationIdEq** | **String**| Application filter. | [optional]

### Return type

[**AccessKeyList**](AccessKeyList.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Loading