CircleOfTrust
Realm Operations
Resource path:
/realm-config/federation/circlesoftrust
Resource version: 1.0
create
Usage
am> create CircleOfTrust --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" : { "saml2ReaderServiceUrl" : { "title" : "SAML2 Reader Service URL", "description" : "Location of the SAML2 Reader service that reads the cookie from the Common Domain.", "propertyOrder" : 500, "required" : false, "type" : "string", "exampleValue" : "" }, "description" : { "title" : "Description", "description" : "", "propertyOrder" : 100, "required" : false, "type" : "string", "exampleValue" : "" }, "status" : { "title" : "Status", "description" : "", "propertyOrder" : 200, "required" : false, "type" : "string", "exampleValue" : "" }, "saml2WriterServiceUrl" : { "title" : "SAML2 Writer Service URL", "description" : "Location of the SAML2 Writer service that writes the cookie to the Common Domain.", "propertyOrder" : 400, "required" : false, "type" : "string", "exampleValue" : "" }, "trustedProviders" : { "title" : "Entity Providers", "description" : "Minimum requirements for a circle of trust are one identity provider and one service provider.", "propertyOrder" : 300, "required" : false, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }
delete
Usage
am> delete CircleOfTrust --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query CircleOfTrust --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read CircleOfTrust --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update CircleOfTrust --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" : { "saml2ReaderServiceUrl" : { "title" : "SAML2 Reader Service URL", "description" : "Location of the SAML2 Reader service that reads the cookie from the Common Domain.", "propertyOrder" : 500, "required" : false, "type" : "string", "exampleValue" : "" }, "description" : { "title" : "Description", "description" : "", "propertyOrder" : 100, "required" : false, "type" : "string", "exampleValue" : "" }, "status" : { "title" : "Status", "description" : "", "propertyOrder" : 200, "required" : false, "type" : "string", "exampleValue" : "" }, "saml2WriterServiceUrl" : { "title" : "SAML2 Writer Service URL", "description" : "Location of the SAML2 Writer service that writes the cookie to the Common Domain.", "propertyOrder" : 400, "required" : false, "type" : "string", "exampleValue" : "" }, "trustedProviders" : { "title" : "Entity Providers", "description" : "Minimum requirements for a circle of trust are one identity provider and one service provider.", "propertyOrder" : 300, "required" : false, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }