PingOneWorker
Realm Operations
Resource path:
/realm-config/services/pingOneWorkerService/workers
Resource version: 2.0
create
Usage
am> create PingOneWorker --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "clientSecretPurpose" : { "title" : "Client Secret Label Identifier", "description" : "Identifier of the client secret label, similar to an ESV, that stores the client secret of the worker application in PingOne.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "clientId" : { "title" : "Client ID", "description" : "Client ID of the worker application in PingOne.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "authUrl" : { "title" : "PingOne Authorization Server URL", "description" : "Represents the regional domain for the PingOne authentication server.<br><br>Choose from: <ul> <li><code>https://auth.pingone.com</code> - for the North America region (excluding Canada)</li> <li><code>https://auth.pingone.ca</code> - for the Canada region</li> <li><code>https://auth.pingone.eu</code> - for the European Union region</li> <li><code>https://auth.pingone.asia</code> - for the Asia-Pacific region</li> </ul>", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "environmentId" : { "title" : "Environment ID", "description" : "Identifier of the environment that contains the worker application in PingOne.", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "apiUrl" : { "title" : "PingOne API Server URL", "description" : "Represents the regional domain for the PingOne API server.<br><br>Choose from: <ul> <li><code>https://auth.pingone.com/{version}</code> - for the North America region (excluding Canada)</li> <li><code>https://auth.pingone.ca/{version}</code> - for the Canada region</li> <li><code>https://auth.pingone.eu/{version}</code> - for the European Union region</li> <li><code>https://auth.pingone.asia/{version}</code> - for the Asia-Pacific region</li> </ul>", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete PingOneWorker --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action PingOneWorker --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PingOneWorker --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action PingOneWorker --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PingOneWorker --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PingOneWorker --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PingOneWorker --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "clientSecretPurpose" : { "title" : "Client Secret Label Identifier", "description" : "Identifier of the client secret label, similar to an ESV, that stores the client secret of the worker application in PingOne.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "clientId" : { "title" : "Client ID", "description" : "Client ID of the worker application in PingOne.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "authUrl" : { "title" : "PingOne Authorization Server URL", "description" : "Represents the regional domain for the PingOne authentication server.<br><br>Choose from: <ul> <li><code>https://auth.pingone.com</code> - for the North America region (excluding Canada)</li> <li><code>https://auth.pingone.ca</code> - for the Canada region</li> <li><code>https://auth.pingone.eu</code> - for the European Union region</li> <li><code>https://auth.pingone.asia</code> - for the Asia-Pacific region</li> </ul>", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "environmentId" : { "title" : "Environment ID", "description" : "Identifier of the environment that contains the worker application in PingOne.", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "apiUrl" : { "title" : "PingOne API Server URL", "description" : "Represents the regional domain for the PingOne API server.<br><br>Choose from: <ul> <li><code>https://auth.pingone.com/{version}</code> - for the North America region (excluding Canada)</li> <li><code>https://auth.pingone.ca/{version}</code> - for the Canada region</li> <li><code>https://auth.pingone.eu/{version}</code> - for the European Union region</li> <li><code>https://auth.pingone.asia/{version}</code> - for the Asia-Pacific region</li> </ul>", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }