ジャンプ先

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

DNによる暗号化マネージャの検索

GET

/rest/v1/admin/{dn}

DNによって暗号化マネージャを返します

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array[string]
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。
• controls: array[string]
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。
• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: 暗号化マネージャのGetSuccessResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Crypto Manager SearchResultEntry"
            }
        }
    }
}

ネストされたスキーマ: searchResultEntries

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• 配列: オブジェクト 暗号化マネージャのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Crypto Manager SearchResultEntry"
    }
}

ネストされたスキーマ: 暗号化マネージャのSearchResultEntry

型: object

ソースを表示

• attributes(required): object 暗号化マネージャのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Crypto Manager Properties"
        }
    }
}

ネストされたスキーマ: 暗号化マネージャのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-cipher-key-length: integer(int32)
  デフォルト値: 128

  推奨暗号化方式のキー長をビット単位で指定します。
• ds-cfg-cipher-transformation: string
  デフォルト値: AES/CBC/PKCS5Padding

  algorithm/mode/paddingの構文を使用して、ディレクトリ・サーバーの暗号化方式を指定します。
• ds-cfg-digest-algorithm: string
  デフォルト値: SHA-1

  ディレクトリ・サーバーの優先メッセージ・ダイジェスト・アルゴリズムを指定します。
• ds-cfg-key-wrapping-transformation: string
  デフォルト値: RSA/ECB/OAEPWITHSHA-1ANDMGF1PADDING

  ディレクトリ・サーバーの優先キー・ラッピング変換。この値は、レプリケーション・トポロジ内のすべてのサーバー・インスタンスで同じである必要があります。
• ds-cfg-mac-algorithm: string
  デフォルト値: HmacSHA1

  ディレクトリ・サーバーの優先MACアルゴリズムを指定します。
• ds-cfg-mac-key-length: integer(int32)
  デフォルト値: 128

  優先MACアルゴリズムのキー長をビット単位で指定します。
• ds-cfg-password-storage-scheme: string
  デフォルト値: AES

  様々なコンポーネントでパスワードのエンコードに使用されるパスワード記憶スキームを指定します。
• ds-cfg-ssl-cert-nickname: string
  SSL通信を実行する場合に、暗号化マネージャが使用する必要がある証明書のニックネーム(別名とも呼ばれる)を指定します。
• ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite
  SSLまたはTLS通信で使用できるSSL暗号スイートの名前を指定します。
• ds-cfg-ssl-encryption: boolean
  デフォルト値: false

  2つのOracle Unified Directoryサーバー・コンポーネント間で暗号化通信を実行する場合に、SSL/TLSを使用するかどうかを指定します。
• ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol
  SSLまたはTLS通信で使用できるSSLプロトコルの名前を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-password-storage-scheme":{
            "description":"Specifies the password storage scheme that is used to encode passwords for various components. ",
            "readOnly":false,
            "default":"AES",
            "type":"string"
        },
        "ds-cfg-key-wrapping-transformation":{
            "description":"The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology. ",
            "readOnly":false,
            "default":"RSA/ECB/OAEPWITHSHA-1ANDMGF1PADDING",
            "type":"string"
        },
        "ds-cfg-cipher-key-length":{
            "description":"Specifies the key length in bits for the preferred cipher. ",
            "readOnly":false,
            "default":"128",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-mac-key-length":{
            "description":"Specifies the key length in bits for the preferred MAC algorithm. ",
            "readOnly":false,
            "default":"128",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-mac-algorithm":{
            "description":"Specifies the preferred MAC algorithm for the Directory Server. ",
            "readOnly":false,
            "default":"HmacSHA1",
            "type":"string"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the Crypto Manager should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-digest-algorithm":{
            "description":"Specifies the preferred message digest algorithm for the Directory Server. ",
            "readOnly":false,
            "default":"SHA-1",
            "type":"string"
        },
        "ds-cfg-cipher-transformation":{
            "description":"Specifies the cipher for the Directory Server using the syntax algorithm/mode/padding. ",
            "readOnly":false,
            "default":"AES/CBC/PKCS5Padding",
            "type":"string"
        },
        "ds-cfg-ssl-encryption":{
            "description":"Specifies whether SSL/TLS is used to provide encrypted communication between two Oracle Unified Directory server components. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-ssl-cipher-suite

型: array

SSLまたはTLS通信で使用できるSSL暗号スイートの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-protocol

型: array

SSLまたはTLS通信で使用できるSSLプロトコルの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る