ジャンプ先

• リクエスト
• レスポンス

この証明書管理の表示

get

/management/weblogic/{version}/serverConfig/securityConfiguration/certificateManagement

この証明書管理を表示します。

リクエスト

パス・パラメータ

• version(required): string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields: string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks: string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields: string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links: string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

この証明書管理を返します。

このメソッドは次のリンクを返すことができます。

• rel=certificateIssuerPlugins uri=/management/weblogic/{version}/serverConfig/securityConfiguration/certificateManagement/certificateIssuerPlugins

  このリソースのcertificateIssuerPluginsコレクション・リソース。

• rel=configurationProperties uri=/management/weblogic/{version}/serverConfig/securityConfiguration/certificateManagement/configurationProperties

  このリソースのconfigurationPropertiesコレクション・リソース。

本文()

ルート・スキーマ: 証明書管理

型: object

ソースの表示

• certificateAuthorityValidityPeriod: integer(int32)
  最小値: 45

  最大値: 1825

  デフォルト値: 365

  新しい認証局の証明書を生成する際に、ドメイン証明書の発行者が設定する必要のある有効期間(証明書の存続期間)を返します。有効期間は日数で表します。

• certificateCheckInterval: integer(int32)
  最小値: 1

  最大値: 7

  デフォルト値: 1

  証明書のチェック間隔を返します。これは、証明書管理サービスで、既存の証明書をチェック/リフレッシュする頻度(日数)です。

• certificateRefreshWindow: integer(int32)
  最小値: 5

  最大値: 30

  デフォルト値: 10

  証明書のリフレッシュ・ウィンドウを返します。有効期限が近い証明書の残りの有効期間がこの日数より短くなると、証明書管理サービスによりリフレッシュされます。

• certificateValidityPeriod: integer(int32)
  最小値: 15

  最大値: 365

  デフォルト値: 90

  新しい証明書を生成する際に、ドメイン証明書の発行者が設定する必要のある有効期間(証明書の存続期間)を返します。有効期間は日数で表します。

• dynamicallyCreated: boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• enabled: boolean
  デフォルト値: false

  trueまたはfalseを返して、証明書管理サービスが有効かどうかを示します。

• id: integer(int64)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• includeRootCertificateInChain: boolean
  デフォルト値: true

  ドメイン証明書の発行者が、生成された証明書の証明書チェーンに、自己署名ルートCAを含める必要があるかどうか。

• javaStandardTrustEnabled: boolean
  デフォルト値: false

  ドメインごとの認証局の証明書やプロビジョニングされた信頼証明書に加えて、ドメインで、Java標準信頼証明書を信頼する必要があるかどうか。Java標準信頼は、既知の信頼性のあるルート認証局のコレクションで、JDKの一部として配布(および更新)されます。

• name: string
  読取り専用: true

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• notes: string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• provisionedCertificatesIssuerEnabled: boolean
  デフォルト値: false

  trueまたはfalseを返して、プロビジョニングされた証明書発行者が有効かどうかを示します。

• singlePurposeCertificatesEnabled: boolean
  デフォルト値: false

  単一目的の証明書で有効になっている値を返します。ドメイン証明書の発行者が生成する必要のある証明書が、目的別(サーバー認証、クライアント認証、署名および暗号化)の単一目的の証明書と、これらすべての目的に対応する1つの証明書のどちらであるかです。

  制約

  • セキュア・デフォルト: true
• subjectAlternativeNames: string
  デフォルト値: hostname, address, loopback, listen_address_all, virtual_host_all

  サブジェクトの代替名を表す単語をスペースまたはカンマで区切ったリストで、ドメイン証明書の発行者が、サーバー証明書を生成する際に指定する必要があります。

  それぞれの単語は、CertificateConfigurationConstantsインタフェースで定義されているサブジェクト名定数のいずれかであることが必要です。各定数は、証明書管理サービスにより、証明書の生成時に、ターゲット・サーバーの構成またはこのサービスが実行されているホストから取得された対応する値で置き換えられます。

  証明書のCN属性は、ここで明示的に構成されていない場合でも、サブジェクト代替名として指定されます。

• subjectCommonName: string
  デフォルト値: hostname

  指定可能な値: [ "hostname", "listen_address" ]

  ドメイン証明書の発行者が、証明書のサブジェクトのCN属性に使用する必要がある名前: ローカル・ホスト名(hostname)またはサーバーのリスニング・アドレス(listen_address)のいずれかです。

  サーバーにリスニング・アドレスが構成されていない場合は、ここで設定した値に関係なく、ホスト名がかわりに使用されます。

  CN値も、(サブジェクト代替名として明示的に構成されていない場合でも)サブジェクト代替名として追加されます。

• tags: array 項目
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• type: string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "certificateAuthorityValidityPeriod":{
            "default":365,
            "minimum":45,
            "maximum":1825,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new Certificate Authority certificate. The validity period is expressed in days.</p>"
        },
        "certificateCheckInterval":{
            "default":1,
            "minimum":1,
            "maximum":7,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the certificate check interval -- how often the Certificate Management Service should check for/refresh expiring certificates (in days).</p>"
        },
        "certificateRefreshWindow":{
            "default":10,
            "minimum":5,
            "maximum":30,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the certificate refresh window. The Certificate Management Service will refresh an expiring certificate when its remaining lifetime is less than this number of days.</p>"
        },
        "certificateValidityPeriod":{
            "default":90,
            "minimum":15,
            "maximum":365,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new certificate. The validity period is expressed in days.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Returns true or false to indicate whether the Certificate Management Service is enabled or not.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "includeRootCertificateInChain":{
            "default":true,
            "type":"boolean",
            "description":"<p>Whether the Domain Certificates Issuer should include the self-signed root CA in the certificate chain for a generated certificate.</p>"
        },
        "javaStandardTrustEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Whether or not the domain should trust the Java Standard Trust certificates, in addition to the Domain Certificate Authority certificate(s) and any Provisioned Trust certificates. Java Standard Trust is a collection of well-known, trusted root certificate authorities distributed (and updated) as part of the JDK.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "provisionedCertificatesIssuerEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Returns true or false to indicate whether the Provisioned Certificates Issuer is enabled or not.</p>"
        },
        "singlePurposeCertificatesEnabled":{
            "x-weblogic-secureDefault":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Returns the single purpose certificates enabled value: whether the Domain Certificates Issuer should generate separate, single-purpose certificates for different purposes (server authentication, client authentication, signing and encryption), or generate one certificate that supports all those purposes.</p><p><h5>Constraints</h5></p><ul><li>secure default : true</li></ul>"
        },
        "subjectAlternativeNames":{
            "default":"hostname, address, loopback, listen_address_all, virtual_host_all",
            "type":"string",
            "description":"<p>A space- or comma-separated list of words representing the Subject Alternative Names that the Domain Certificates Issuer should include when generating a server certificate.</p><p>Each word must be one of the subject name constants defined by the CertificateConfigurationConstants interface. When generating a certificate, the Certificate Management Service replaces each constant with the corresponding value(s) obtained from the target server's configuration or the host it's running on.</p><p>The certificate's CN attribute will be included as a Subject Alternative Name even if it is not explicitly configured here.</p>"
        },
        "subjectCommonName":{
            "default":"hostname",
            "enum":[
                "hostname",
                "listen_address"
            ],
            "type":"string",
            "description":"<p>The name the Domain Certificates Issuer should use for the CN attribute of a certificate's Subject: either the local hostname (<code>hostname</code>) or the server's listen address (<code>listen_address</code>).</p><p>If no listen address is configured for the server, hostname will be used instead, regardless of the value set here.</p><p>The CN value will also be added as a Subject Alternative Name (even if it is not explicitly configured as a Subject Alternative Name).</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

先頭に戻る