--- title: RemoteConsentService description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-remoteconsentservice canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-remoteconsentservice.html section_ids: sec-amster-entity-remoteconsentservice-realm-ops: Realm Operations sec-amster-entity-remoteconsentservice-realm-ops-create: create sec-amster-entity-remoteconsentservice-realm-ops-delete: delete sec-amster-entity-remoteconsentservice-realm-ops-getalltypes: getAllTypes sec-amster-entity-remoteconsentservice-realm-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-remoteconsentservice-realm-ops-nextdescendents: nextdescendents sec-amster-entity-remoteconsentservice-realm-ops-read: read sec-amster-entity-remoteconsentservice-realm-ops-update: update sec-amster-entity-remoteconsentservice-global-ops: Global Operations sec-amster-entity-remoteconsentservice-global-ops-getalltypes: getAllTypes sec-amster-entity-remoteconsentservice-global-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-remoteconsentservice-global-ops-nextdescendents: nextdescendents sec-amster-entity-remoteconsentservice-global-ops-read: read sec-amster-entity-remoteconsentservice-global-ops-update: update --- # RemoteConsentService ## Realm Operations Resource path: ``` /realm-config/services/RemoteConsentService ``` Resource version: `0.0` ### create **Usage** ``` am> create RemoteConsentService --realm Realm --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "clientId" : { "title" : "Client Name", "description" : "The name used to identify this OAuth 2.0 remote consent service when referencedin other services.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "consentResponseTimeLimit" : { "title" : "Consent Response Time Limit (in minutes)", "description" : "The time limit set on the consent response JWT before it expires, in minutes.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "jwksUriAS" : { "title" : "Authorization Server jwk_uri", "description" : "The jwk_uri for retrieving the authorization server signing and encryption keys.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "jwkStoreCacheTimeout" : { "title" : "JWK Store Cache Timeout (in minutes)", "description" : "The cache timeout for the JWK store of the authorization server, in minutes.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" }, "jwkStoreCacheMissCacheTime" : { "title" : "JWK Store Cache Miss Cache Time (in minutes)", "description" : "The length of time a cache miss is cached, in minutes.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" } } } ``` ### delete **Usage** ``` am> delete RemoteConsentService --realm Realm ``` ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action RemoteConsentService --realm Realm --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action RemoteConsentService --realm Realm --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action RemoteConsentService --realm Realm --actionName nextdescendents ``` ### read **Usage** ``` am> read RemoteConsentService --realm Realm ``` ### update **Usage** ``` am> update RemoteConsentService --realm Realm --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "clientId" : { "title" : "Client Name", "description" : "The name used to identify this OAuth 2.0 remote consent service when referencedin other services.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "consentResponseTimeLimit" : { "title" : "Consent Response Time Limit (in minutes)", "description" : "The time limit set on the consent response JWT before it expires, in minutes.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "jwksUriAS" : { "title" : "Authorization Server jwk_uri", "description" : "The jwk_uri for retrieving the authorization server signing and encryption keys.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "jwkStoreCacheTimeout" : { "title" : "JWK Store Cache Timeout (in minutes)", "description" : "The cache timeout for the JWK store of the authorization server, in minutes.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" }, "jwkStoreCacheMissCacheTime" : { "title" : "JWK Store Cache Miss Cache Time (in minutes)", "description" : "The length of time a cache miss is cached, in minutes.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" } } } ``` ## Global Operations Resource path: ``` /global-config/services/RemoteConsentService ``` Resource version: `1.0` ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action RemoteConsentService --global --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action RemoteConsentService --global --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action RemoteConsentService --global --actionName nextdescendents ``` ### read **Usage** ``` am> read RemoteConsentService --global ``` ### update **Usage** ``` am> update RemoteConsentService --global --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "defaults" : { "properties" : { "consentResponseTimeLimit" : { "title" : "Consent Response Time Limit (in minutes)", "description" : "The time limit set on the consent response JWT before it expires, in minutes.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "clientId" : { "title" : "Client Name", "description" : "The name used to identify this OAuth 2.0 remote consent service when referencedin other services.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "jwksUriAS" : { "title" : "Authorization Server jwk_uri", "description" : "The jwk_uri for retrieving the authorization server signing and encryption keys.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "jwkStoreCacheMissCacheTime" : { "title" : "JWK Store Cache Miss Cache Time (in minutes)", "description" : "The length of time a cache miss is cached, in minutes.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" }, "jwkStoreCacheTimeout" : { "title" : "JWK Store Cache Timeout (in minutes)", "description" : "The cache timeout for the JWK store of the authorization server, in minutes.", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } } ```