IoTService
Realm Operations
Resource path:
/realm-config/services/iot
Resource version: 1.0
create
Usage
am> create IoTService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "oauthClientName" : { "title" : "OAuth 2.0 Client Name", "description" : "The name of the default OAuth 2.0 Client used by the IoT Service to request access tokens for things.", "propertyOrder" : 20, "required" : true, "type" : "string", "exampleValue" : "" }, "attributeAllowlist" : { "title" : "Readable Attributes", "description" : "Specifies the list of attributes that a thing is allowed to request from its identity.", "propertyOrder" : 50, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "oauthSubjectAttribute" : { "title" : "OAuth 2.0 Subject Attribute", "description" : "The name of the identity store attribute from which to read the OAuth 2.0 subject value. The subject is used in access tokens issued for things. This allows the thing's access token subject to have a value other than the thing's ID, which is the value used by default.", "propertyOrder" : 45, "required" : false, "type" : "string", "exampleValue" : "" }, "oauthJwtIssuerName" : { "title" : "OAuth 2.0 JWT Issuer Name", "description" : "The name of the Trusted JWT Issuer used by the IoT Service to request access tokens for things.", "propertyOrder" : 40, "required" : true, "type" : "string", "exampleValue" : "" }, "createOAuthClient" : { "title" : "Create OAuth 2.0 Client", "description" : "Create an OAuth 2.0 Client with the given name and default configuration required to serve as the client for the IoT Service. The client will be created without any scope(s).", "propertyOrder" : 10, "required" : true, "type" : "boolean", "exampleValue" : "" }, "createOAuthJwtIssuer" : { "title" : "Create OAuth 2.0 JWT Issuer", "description" : "Create a Trusted JWT Issuer with the given name and default configuration required for the IoT Service to act as the Issuer when handling request for thing access tokens.", "propertyOrder" : 30, "required" : true, "type" : "boolean", "exampleValue" : "" } } }
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action IoTService --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action IoTService --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action IoTService --realm Realm --actionName nextdescendents
update
Usage
am> update IoTService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "oauthClientName" : { "title" : "OAuth 2.0 Client Name", "description" : "The name of the default OAuth 2.0 Client used by the IoT Service to request access tokens for things.", "propertyOrder" : 20, "required" : true, "type" : "string", "exampleValue" : "" }, "attributeAllowlist" : { "title" : "Readable Attributes", "description" : "Specifies the list of attributes that a thing is allowed to request from its identity.", "propertyOrder" : 50, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "oauthSubjectAttribute" : { "title" : "OAuth 2.0 Subject Attribute", "description" : "The name of the identity store attribute from which to read the OAuth 2.0 subject value. The subject is used in access tokens issued for things. This allows the thing's access token subject to have a value other than the thing's ID, which is the value used by default.", "propertyOrder" : 45, "required" : false, "type" : "string", "exampleValue" : "" }, "oauthJwtIssuerName" : { "title" : "OAuth 2.0 JWT Issuer Name", "description" : "The name of the Trusted JWT Issuer used by the IoT Service to request access tokens for things.", "propertyOrder" : 40, "required" : true, "type" : "string", "exampleValue" : "" }, "createOAuthClient" : { "title" : "Create OAuth 2.0 Client", "description" : "Create an OAuth 2.0 Client with the given name and default configuration required to serve as the client for the IoT Service. The client will be created without any scope(s).", "propertyOrder" : 10, "required" : true, "type" : "boolean", "exampleValue" : "" }, "createOAuthJwtIssuer" : { "title" : "Create OAuth 2.0 JWT Issuer", "description" : "Create a Trusted JWT Issuer with the given name and default configuration required for the IoT Service to act as the Issuer when handling request for thing access tokens.", "propertyOrder" : 30, "required" : true, "type" : "boolean", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/services/iot
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action IoTService --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action IoTService --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action IoTService --global --actionName nextdescendents
update
Usage
am> update IoTService --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "defaults" : { "properties" : { "oauthSubjectAttribute" : { "title" : "OAuth 2.0 Subject Attribute", "description" : "The name of the identity store attribute from which to read the OAuth 2.0 subject value. The subject is used in access tokens issued for things. This allows the thing's access token subject to have a value other than the thing's ID, which is the value used by default.", "propertyOrder" : 45, "required" : false, "type" : "string", "exampleValue" : "" }, "attributeAllowlist" : { "title" : "Readable Attributes", "description" : "Specifies the list of attributes that a thing is allowed to request from its identity.", "propertyOrder" : 50, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "createOAuthClient" : { "title" : "Create OAuth 2.0 Client", "description" : "Create an OAuth 2.0 Client with the given name and default configuration required to serve as the client for the IoT Service. The client will be created without any scope(s).", "propertyOrder" : 10, "required" : true, "type" : "boolean", "exampleValue" : "" }, "oauthJwtIssuerName" : { "title" : "OAuth 2.0 JWT Issuer Name", "description" : "The name of the Trusted JWT Issuer used by the IoT Service to request access tokens for things.", "propertyOrder" : 40, "required" : true, "type" : "string", "exampleValue" : "" }, "oauthClientName" : { "title" : "OAuth 2.0 Client Name", "description" : "The name of the default OAuth 2.0 Client used by the IoT Service to request access tokens for things.", "propertyOrder" : 20, "required" : true, "type" : "string", "exampleValue" : "" }, "createOAuthJwtIssuer" : { "title" : "Create OAuth 2.0 JWT Issuer", "description" : "Create a Trusted JWT Issuer with the given name and default configuration required for the IoT Service to act as the Issuer when handling request for thing access tokens.", "propertyOrder" : 30, "required" : true, "type" : "boolean", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } }