ジャンプ先

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

DNによるREST Webサービス拡張機能の検索

GET

/rest/v1/admin/{dn}

DNによってREST Webサービス拡張機能を返します

リクエスト

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

• 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レスポンス

OK

本文 ()

ルート・スキーマ: REST Webサービス拡張機能の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/REST Web Service Extension SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト REST Webサービス拡張機能のSearchResultEntry

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

ネストされたスキーマ: REST Webサービス拡張機能のSearchResultEntry

型: object

ソースを表示

• attributes: object REST Webサービス拡張機能のプロパティ
• 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/REST Web Service Extension Properties"
        }
    }
}

ネストされたスキーマ: REST Webサービス拡張機能のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-authentication-schemes-documentation-url(optional): string
  デフォルト値: http://www.oracle.com

  RESTful Webサービス認証スキームのドキュメントをホストするURLを指定します。
• ds-cfg-authentication-schemes-spec-url(optional): string
  デフォルト値: http://www.oracle.com

  認証スキーム仕様のドキュメントをホストするURLを指定します。
• ds-cfg-bulk-max-operations(optional): integer(int32)
  デフォルト値: 1000

  許容できるバルク操作の最大数を指定します。REST Webサービス拡張機能。
• ds-cfg-bulk-max-payload-size(optional): integer(int32)
  デフォルト値: 1000

  REST Webサービス拡張機能を使用する際のバルク操作の最大ペイロード・サイズを指定します。
• ds-cfg-bulk-supported(optional): boolean
  デフォルト値: true

  バルク操作がこのREST Webサービス拡張機能でサポートされるかどうか。
• ds-cfg-enabled: boolean
  拡張機能が使用可能かどうかを示します。
• ds-cfg-etag-supported(optional): boolean
  デフォルト値: false

  EtagがこのREST Webサービス拡張機能でサポートされるかどうかを指定します。
• ds-cfg-filter-max-results(optional): integer(int32)
  デフォルト値: 1000

  フィルタの使用時の最大結果サイズを指定します。REST Webサービス拡張機能。
• ds-cfg-filter-supported(optional): boolean
  デフォルト値: true

  検索フィルタがWebサービスでサポートされるかどうかを指定します。REST Webサービス拡張機能。
• ds-cfg-java-class: string
  デフォルト値: com.oracle.scim.RESTWebServiceExtension

  REST Webサービス拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-patch-supported(optional): boolean
  デフォルト値: true

  PATCH操作がWebサービスによってサポートされるかどうかを指定します。REST Webサービス拡張機能。
• ds-cfg-rest-context(optional): string
  デフォルト値: /idaas/rest

  RESTful Webサービス・コンテキストを指定します。REST Webサービス拡張機能。
• ds-cfg-rest-documentation-url(optional): string
  デフォルト値: http://www.oracle.com

  REST Webサービス拡張機能のドキュメントをホストするURLを指定します。
• ds-cfg-sort-supported(optional): boolean
  デフォルト値: false

  検索結果のソートがこのREST Webサービス拡張機能でサポートされるかどうかを指定します。REST Webサービス拡張機能。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled"
    ],
    "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":"Specifies the fully-qualified name of the Java class that provides the REST Web Service Extension implementation. ",
            "readOnly":false,
            "default":"com.oracle.scim.RESTWebServiceExtension",
            "type":"string"
        },
        "ds-cfg-rest-documentation-url":{
            "description":"Specifies the URL hosting the documentation for REST Web Service Extension. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-filter-max-results":{
            "description":"Specifies the maxium result size while using filters. REST Web Service Extension. ",
            "readOnly":false,
            "default":1000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-bulk-max-payload-size":{
            "description":"Specifies the max payload size for the bulk operations while using REST Web Service Extension. ",
            "readOnly":false,
            "default":1000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-filter-supported":{
            "description":"Specifies whether or not the Search filters will be supported by the web service. REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-patch-supported":{
            "description":"Specifies whether or not the PATCH operation is supported by the web service. REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-rest-context":{
            "description":"Specifies the RESTful web service context. REST Web Service Extension. ",
            "readOnly":false,
            "default":"/idaas/rest",
            "type":"string"
        },
        "ds-cfg-bulk-max-operations":{
            "description":"Specifies the maximum number of allowable bulk operations. REST Web Service Extension. ",
            "readOnly":false,
            "default":1000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-supported":{
            "description":"Specifies whether or not the sorting of the search results is supported by this REST Web Service Extension. REST Web Service Extension. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-authentication-schemes-spec-url":{
            "description":"Specifies the URL hosting the documentation for authentication schemes specifications. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-authentication-schemes-documentation-url":{
            "description":"Specifies the URL hosting the documentation for RESTful web services authentication schemes. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-etag-supported":{
            "description":"Specifies whether or not the etag is supported by this REST Web Service Extension. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bulk-supported":{
            "description":"Whether or not the bulk operations are supported by this REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

先頭に戻る