RemoteConsentService

Realm Operations

Resource path:

/realm-config/services/RemoteConsentService

Resource version: 1.0

create

Usage

am> create RemoteConsentService --realm Realm --body body

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "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" : ""
    },
    "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" : ""
    },
    "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" : ""
    },
    "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" : ""
    }
  }
}

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:

{
  "type" : "object",
  "properties" : {
    "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" : ""
    },
    "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" : ""
    },
    "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" : ""
    },
    "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" : ""
    }
  }
}

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:

{
  "type" : "object",
  "properties" : {
    "defaults" : {
      "properties" : {
        "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" : ""
        },
        "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" : ""
        },
        "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" : ""
        }
      },
      "type" : "object",
      "title" : "Realm Defaults"
    }
  }
}