Oracle Unified Directoryの管理REST API: DNによるファイル・ベース監査ログ・パブリッシャの検索

DNによるファイル・ベース監査ログ・パブリッシャの検索

GET

/rest/v1/admin/{dn}

DNによってファイル・ベース監査ログ・パブリッシャを返します

リクエスト

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

application/json

パス・パラメータ

dn: string

フェッチするエントリのLDAP DN。

問合せパラメータ

attributes: array

コレクション形式: multi

エントリに対してフェッチする属性のリスト。

[0]: string

{
    "name":"attributes",
    "in":"query",
    "description":"List of attributes to be fetched for the entry.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

controls: array

コレクション形式: multi

検索操作のためにサーバーに送信するLDAP制御。

[0]: string

{
    "name":"controls",
    "in":"query",
    "description":"LDAP controls to be sent to server for search operation.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

filter: string

LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
scope: string

LDAP検索操作の範囲。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: ファイル・ベース監査ログ・パブリッシャのGetSuccessResponse

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

RESTメッセージ・タイプ
searchResultEntries: array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults: 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/File Based Audit Log Publisher SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object ファイル・ベース監査ログ・パブリッシャのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/File Based Audit Log Publisher SearchResultEntry"
    }
}

ネストされたスキーマ: ファイル・ベース監査ログ・パブリッシャのSearchResultEntry

型: object

ソースを表示

attributes: object ファイル・ベース監査ログ・パブリッシャのプロパティ
dn: string

作成するエントリのLDAP DN。

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

ネストされたスキーマ: ファイル・ベース監査ログ・パブリッシャのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-append(optional): boolean

デフォルト値: true

既存のログ・ファイルに追加するかどうかを指定します。
ds-cfg-asynchronous: boolean

デフォルト値: true

ファイル・ベース監査ログ・パブリッシャでレコードを非同期的に公開するかどうかを示します。
ds-cfg-auto-flush(optional): boolean

デフォルト値: true

ログ・レコードを書き込むたびに、ライターをフラッシュするかどうかを指定します。
ds-cfg-buffer-size(optional): string

デフォルト値: 64kb

ログ・ファイル・バッファのサイズを指定します。
ds-cfg-enabled: boolean

ログ・パブリッシャが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.loggers.TextAuditLogPublisher

ファイル・ベース監査ログ・パブリッシャの実装を提供するJavaクラスの完全修飾名。
ds-cfg-log-controls(optional): boolean

デフォルト値: false

クライアント・アプリケーションによってリクエストされた操作とともにリクエスト制御およびレスポンス制御をログに記録する必要があるかどうかを示します。
ds-cfg-log-file: string

ファイル・ベース監査ログ・パブリッシャによって生成されたログ・ファイルに使用されるファイル名。ファイルへのパスは、サーバー・ルートに対して相対的です。
ds-cfg-log-file-permissions: string

デフォルト値: 640

このファイル・ベース監査ログ・パブリッシャで作成されたログ・ファイルのUNIXアクセス権。
ds-cfg-log-file-use-local-time(optional): boolean

デフォルト値: false

ローテーションされるファイルの名前にローカル時間とGMTのどちらを使用するかを指定します。
ds-cfg-log-qtime(optional): boolean

デフォルト値: false

操作でキューの前処理に要した時間をログに記録します。
ds-cfg-mask-passwords(optional): boolean

デフォルト値: true

監査ログでパスワード属性値をマスクする必要があるかどうかを示します。デフォルト値はtrueです。
ds-cfg-masked-attribute(optional): array ds-cfg-masked-attribute

ログ・ファイルで値をマスクする属性を定義できます。これは現在監査ログにのみ関連します。masked-suffixを指定した場合は、該当する接尾辞の下位にあるエントリの属性のみがマスクされます。
ds-cfg-masked-suffix(optional): array ds-cfg-masked-suffix

監査ログで属性マスクを行う接尾辞を定義できます。これは現在監査ログにのみ関連します。
ds-cfg-masking-uses-encryption-config(optional): boolean

デフォルト値: true

監査ログでの属性マスクで暗号化構成も考慮するかどうかを示します。trueの場合、データ暗号化構成のattribute-encryption-includeおよびencrypted-suffix属性を使用して、監査ログでのマスクの対象とする接尾辞とその下位の属性を定義します。falseの場合、データ暗号化構成は考慮されません。値がtrueの場合、暗号化構成に定義された属性は、属性の暗号化を有効にした場合にのみマスクされます。この属性は、常に評価されるmasked-attributeおよびmasked-suffixの使用には影響しません。
ds-cfg-operations-to-log(optional): array ds-cfg-operations-to-log

ログに記録する操作を示します。
ds-cfg-queue-size(optional): integer(int32)

デフォルト値: 5000

非同期キューに格納できる最大ログ・レコード数。
ds-cfg-retention-policy(optional): array ds-cfg-retention-policy

ファイル・ベース監査ログ・パブリッシャに使用する保持ポリシー。
ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy

ファイル・ベース監査ログ・パブリッシャに使用するローテーション・ポリシー。
ds-cfg-time-interval(optional): string

デフォルト値: 5s

ログ・ファイルをローテーションする必要があるかどうかを確認する間隔を指定します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "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-java-class":{
            "description":"The fully-qualified name of the Java class that provides the File Based Audit Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.TextAuditLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-masked-suffix":{
            "description":"Allows to define the suffixes in which attributes masking in the audit log should occur. This is currently only relevant for the audit log. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Audit Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-masking-uses-encryption-config":{
            "description":"Indicates whether attribute masking in the audit log should also take care of encryption configuration. If true, attribute-encryption-include and encrypted-suffix attributes in data encryption configuration are used to define which attributes under which suffixes should be masked in the audit log. If false, data encryption configuration is not taken into account. If value is true, attributes defined in encryption configuration will only be masked if attribute encryption is enabled. This attribute does not impact usage of masked-attribute and masked-suffix which are always evaluated. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Audit Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-mask-passwords":{
            "description":"Indicates whether the password attributes values should be masked in the audit log. Default value is true. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based Audit Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-masked-attribute":{
            "description":"Allows to define some attributes whose value will be masked in the log file. This is currently only relevant for the audit log. If masked-suffix is filled, only attributes of entries under those suffixes are masked. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Audit Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based Audit Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-masked-attribute

型: array

ログ・ファイルで値をマスクする属性を定義できます。これは現在監査ログにのみ関連します。masked-suffixを指定した場合は、該当する接尾辞の下位にあるエントリの属性のみがマスクされます。

ソースを表示

[0]: string

{
    "description":"Allows to define some attributes whose value will be masked in the log file. This is currently only relevant for the audit log. If masked-suffix is filled, only attributes of entries under those suffixes are masked. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-masked-suffix

型: array

監査ログで属性マスクを行う接尾辞を定義できます。これは現在監査ログにのみ関連します。

ソースを表示

[0]: string

{
    "description":"Allows to define the suffixes in which attributes masking in the audit log should occur. This is currently only relevant for the audit log. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-operations-to-log

型: array

ログに記録する操作を示します。

デフォルト値: [ "administration", "user", "adminbrowsing", "synchronization" ]

指定可能な値: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

ソースを表示

[0]: string

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing",
        "synchronization"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "internal",
        "synchronization",
        "user"
    ]
}

ネストされたスキーマ: ds-cfg-retention-policy

型: array

ファイル・ベース監査ログ・パブリッシャに使用する保持ポリシー。

ソースを表示

[0]: string

{
    "description":"The retention policy to use for the File Based Audit Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-rotation-policy

型: array

ファイル・ベース監査ログ・パブリッシャに使用するローテーション・ポリシー。

ソースを表示

[0]: string

{
    "description":"The rotation policy to use for the File Based Audit Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

406レスポンス

受入れできません

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

ldapErrorCode(optional): integer(int32)

操作に対して返されるLDAPエラー・コードを指定します。
message: string

操作に対して返されるエラー・メッセージ。
msgType: 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."
        }
    }
}

先頭に戻る