Jump to

• Request
• Response

Find File Based Audit Log Publisher by DN

get

/rest/v1/admin/{dn}

Returns an File Based Audit Log Publisher by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [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
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [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
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : File Based Audit Log Publisher GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "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"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object File Based Audit Log Publisher SearchResultEntry

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

Nested Schema : File Based Audit Log Publisher SearchResultEntry

Type: object

Show Source

• attributes: object File Based Audit Log Publisher Properties
• dn: string
  LDAP DN of the entry to be created

{
    "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"
        }
    }
}

Nested Schema : File Based Audit Log Publisher Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-append(optional): boolean
  Default Value: true

  Specifies whether to append to existing log files.
• ds-cfg-asynchronous: boolean
  Default Value: true

  Indicates whether the File Based Audit Log Publisher will publish records asynchronously.
• ds-cfg-auto-flush(optional): boolean
  Default Value: true

  Specifies whether to flush the writer after every log record.
• ds-cfg-buffer-size(optional): string
  Default Value: 64kb

  Specifies the log file buffer size.
• ds-cfg-enabled: boolean
  Indicates whether the Log Publisher is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.loggers.TextAuditLogPublisher

  The fully-qualified name of the Java class that provides the File Based Audit Log Publisher implementation.
• ds-cfg-log-controls(optional): boolean
  Default Value: false

  Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
• ds-cfg-log-file: string
  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.
• ds-cfg-log-file-permissions: string
  Default Value: 640

  The UNIX permissions of the log files created by this File Based Audit Log Publisher.
• ds-cfg-log-file-use-local-time(optional): boolean
  Default Value: false

  Specifies whether to use local time or GMT for the name of the rotated files.
• ds-cfg-log-qtime(optional): boolean
  Default Value: false

  Logs the time spent in preprocessing queue for an operation.
• ds-cfg-mask-passwords(optional): boolean
  Default Value: true

  Indicates whether the password attributes values should be masked in the audit log. Default value is true.
• ds-cfg-masked-attribute(optional): array ds-cfg-masked-attribute
  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.
• ds-cfg-masked-suffix(optional): array ds-cfg-masked-suffix
  Allows to define the suffixes in which attributes masking in the audit log should occur. This is currently only relevant for the audit log.
• ds-cfg-masking-uses-encryption-config(optional): boolean
  Default Value: true

  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.
• ds-cfg-operations-to-log(optional): array ds-cfg-operations-to-log
  Indicates which operations has to be logged.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 5000

  The maximum number of log records that can be stored in the asynchronous queue.
• ds-cfg-retention-policy(optional): array ds-cfg-retention-policy
  The retention policy to use for the File Based Audit Log Publisher .
• ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy
  The rotation policy to use for the File Based Audit Log Publisher .
• ds-cfg-time-interval(optional): string
  Default Value: 5s

  Specifies the interval at which to check whether the log files need to be rotated.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "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"
            }
        }
    }
}

Nested Schema : ds-cfg-masked-attribute

Type: array

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.

Show Source

• [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"
    }
}

Nested Schema : ds-cfg-masked-suffix

Type: array

Allows to define the suffixes in which attributes masking in the audit log should occur. This is currently only relevant for the audit log.

Show Source

• [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"
    }
}

Nested Schema : ds-cfg-operations-to-log

Type: array

Indicates which operations has to be logged.

Default Value: [ "administration", "user", "adminbrowsing", "synchronization" ]

Allowed Values: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

Show Source

• [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"
    ]
}

Nested Schema : ds-cfg-retention-policy

Type: array

The retention policy to use for the File Based Audit Log Publisher .

Show Source

• [0]: string

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

Nested Schema : ds-cfg-rotation-policy

Type: array

The rotation policy to use for the File Based Audit Log Publisher .

Show Source

• [0]: string

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

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

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

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

{
    "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."
        }
    }
}

Back to Top