---
title: SoftwarePublisher
description: Agents handler that is responsible for managing agents
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-softwarepublisher
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-softwarepublisher.html
section_ids:
sec-amster-entity-softwarepublisher-realm-ops: Realm Operations
sec-amster-entity-softwarepublisher-realm-ops-create: create
sec-amster-entity-softwarepublisher-realm-ops-delete: delete
sec-amster-entity-softwarepublisher-realm-ops-getalltypes: getAllTypes
sec-amster-entity-softwarepublisher-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-softwarepublisher-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-softwarepublisher-realm-ops-query: query
sec-amster-entity-softwarepublisher-realm-ops-read: read
sec-amster-entity-softwarepublisher-realm-ops-update: update
---
# SoftwarePublisher
## Realm Operations
Agents handler that is responsible for managing agents
Resource path:
```
/realm-config/agents/SoftwarePublisher
```
Resource version: `0.0`
### create
**Usage**
```
am> create SoftwarePublisher --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:
```json
{
"type" : "object",
"properties" : {
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"jwksUri" : {
"title" : "Json Web Key URI",
"description" : "The URI that contains the Software Publisher's public keys in Json Web Key format.",
"propertyOrder" : 34800,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"agentgroup" : {
"title" : "Group",
"description" : "Add the agent to a group to allow inheritance of property values from the group.
Changing the group will update inherited property values.
Inherited property values are copied to the agent.",
"propertyOrder" : 50,
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "integer",
"required" : false
}
}
},
"softwareStatementSigningAlgorithm" : {
"title" : "Software statement signing Algorithm",
"description" : "Signing algorithm to be used when verifying software statement signatures.",
"propertyOrder" : 34500,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "integer",
"required" : false
}
}
},
"userpassword" : {
"title" : "Software publisher secret",
"description" : "Software publisher secret. Used when software statement signatures are HMAC based.",
"propertyOrder" : 33000,
"required" : true,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"issuer" : {
"title" : "Software publisher issuer",
"description" : "Identifier for the software publisher, generally represented as a URL.",
"propertyOrder" : 33001,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : true
}
}
},
"jwkSet" : {
"title" : "Json Web Key",
"description" : "Raw JSON Web Key value containing the Software Publisher's public keys.",
"propertyOrder" : 35100,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
}
}
}
```
### delete
**Usage**
```
am> delete SoftwarePublisher --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 SoftwarePublisher --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action SoftwarePublisher --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action SoftwarePublisher --realm Realm --actionName nextdescendents
```
### query
Querying the agents of a specific type
**Usage**
```
am> query SoftwarePublisher --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read SoftwarePublisher --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update SoftwarePublisher --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:
```json
{
"type" : "object",
"properties" : {
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"jwksUri" : {
"title" : "Json Web Key URI",
"description" : "The URI that contains the Software Publisher's public keys in Json Web Key format.",
"propertyOrder" : 34800,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"agentgroup" : {
"title" : "Group",
"description" : "Add the agent to a group to allow inheritance of property values from the group.
Changing the group will update inherited property values.
Inherited property values are copied to the agent.",
"propertyOrder" : 50,
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "integer",
"required" : false
}
}
},
"softwareStatementSigningAlgorithm" : {
"title" : "Software statement signing Algorithm",
"description" : "Signing algorithm to be used when verifying software statement signatures.",
"propertyOrder" : 34500,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
},
"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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "integer",
"required" : false
}
}
},
"userpassword" : {
"title" : "Software publisher secret",
"description" : "Software publisher secret. Used when software statement signatures are HMAC based.",
"propertyOrder" : 33000,
"required" : true,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"issuer" : {
"title" : "Software publisher issuer",
"description" : "Identifier for the software publisher, generally represented as a URL.",
"propertyOrder" : 33001,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : true
}
}
},
"jwkSet" : {
"title" : "Json Web Key",
"description" : "Raw JSON Web Key value containing the Software Publisher's public keys.",
"propertyOrder" : 35100,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
}
}
}
```