OAuth2SoftwarePublisherAgentGroups

Realm Operations

Agent Groups handler that is responsible for managing agent groups

Resource path: /realm-config/agents/groups/SoftwarePublisher

Resource version: 1.0

create

Usage:

am> create OAuth2SoftwarePublisherAgentGroups --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" : {
    "jwkSet" : {
      "title" : "Json Web Key",
      "description" : "Raw JSON Web Key value containing the Software Publisher's public keys.",
      "propertyOrder" : 35100,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "issuer" : {
      "title" : "Software publisher issuer",
      "description" : "Identifier for the software publisher, generally represented as a URL.",
      "propertyOrder" : 33001,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "publicKeyLocation" : {
      "title" : "Public key selector",
      "description" : "Select how the Software Publisher's public keys should be retrieved by the provider when validating software statement signatures.",
      "propertyOrder" : 34700,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "softwareStatementSigningAlgorithm" : {
      "title" : "Software statement signing Algorithm",
      "description" : "Signing algorithm to be used when verifying software statement signatures.",
      "propertyOrder" : 34500,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "jwkStoreCacheMissCacheTime" : {
      "title" : "JWKs URI content cache miss cache time",
      "description" : "To avoid loading the JWKS URI content for every operation, especially when the kid is not in the jwks content already cached, the JWKS content will be cached for a minimum period of time. This cache miss cache time defines the minimum amount of time the JWKS URI content is cached.",
      "propertyOrder" : 35000,
      "required" : false,
      "type" : "integer",
      "exampleValue" : ""
    },
    "jwksUri" : {
      "title" : "Json Web Key URI",
      "description" : "The URI that contains the Software Publisher's public keys in Json Web Key format.",
      "propertyOrder" : 34800,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "jwksCacheTimeout" : {
      "title" : "JWKs URI content cache timeout in ms",
      "description" : "To avoid loading the JWKS URI content for every operation, the JWKS content is cached. This timeout defines the maximum amount of time the JWKS URI content can be cached before being refreshed.",
      "propertyOrder" : 34900,
      "required" : false,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}

delete

Usage:

am> delete OAuth2SoftwarePublisherAgentGroups --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 OAuth2SoftwarePublisherAgentGroups --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage:

am> action OAuth2SoftwarePublisherAgentGroups --realm Realm --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage:

am> action OAuth2SoftwarePublisherAgentGroups --realm Realm --actionName nextdescendents

query

Querying the agent groups of a specific type

Usage:

am> query OAuth2SoftwarePublisherAgentGroups --realm Realm --filter filter

Parameters:

--filter: A CREST formatted query filter, where "true" will query all.

read

Usage:

am> read OAuth2SoftwarePublisherAgentGroups --realm Realm --id id

Parameters:

--id: The unique identifier for the resource.

update

Usage:

am> update OAuth2SoftwarePublisherAgentGroups --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" : {
    "jwkSet" : {
      "title" : "Json Web Key",
      "description" : "Raw JSON Web Key value containing the Software Publisher's public keys.",
      "propertyOrder" : 35100,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "issuer" : {
      "title" : "Software publisher issuer",
      "description" : "Identifier for the software publisher, generally represented as a URL.",
      "propertyOrder" : 33001,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "publicKeyLocation" : {
      "title" : "Public key selector",
      "description" : "Select how the Software Publisher's public keys should be retrieved by the provider when validating software statement signatures.",
      "propertyOrder" : 34700,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "softwareStatementSigningAlgorithm" : {
      "title" : "Software statement signing Algorithm",
      "description" : "Signing algorithm to be used when verifying software statement signatures.",
      "propertyOrder" : 34500,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "jwkStoreCacheMissCacheTime" : {
      "title" : "JWKs URI content cache miss cache time",
      "description" : "To avoid loading the JWKS URI content for every operation, especially when the kid is not in the jwks content already cached, the JWKS content will be cached for a minimum period of time. This cache miss cache time defines the minimum amount of time the JWKS URI content is cached.",
      "propertyOrder" : 35000,
      "required" : false,
      "type" : "integer",
      "exampleValue" : ""
    },
    "jwksUri" : {
      "title" : "Json Web Key URI",
      "description" : "The URI that contains the Software Publisher's public keys in Json Web Key format.",
      "propertyOrder" : 34800,
      "required" : false,
      "type" : "string",
      "exampleValue" : ""
    },
    "jwksCacheTimeout" : {
      "title" : "JWKs URI content cache timeout in ms",
      "description" : "To avoid loading the JWKS URI content for every operation, the JWKS content is cached. This timeout defines the maximum amount of time the JWKS URI content can be cached before being refreshed.",
      "propertyOrder" : 34900,
      "required" : false,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}