ジャンプ先

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

DNによるSaml Xaspワークフロー要素の検索

GET

/rest/v1/admin/{dn}

DNによってSaml Xaspワークフロー要素を返します

リクエスト

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

• 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

本文 ()

ルート・スキーマ: Saml Xaspワークフロー要素の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/Saml Xasp Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object Saml Xaspワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: Saml Xaspワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes: object Saml Xaspワークフロー要素のプロパティ
• 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/Saml Xasp Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: Saml Xaspワークフロー要素のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-enabled: boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement

  Saml Xaspワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-xasp-attribute-name: string
  検索フィルタ内のエントリのDNを含む属性を定義します(certificatednなど)。
• ds-cfg-xasp-base-dn: string
  フィルタに値がない場合に使用されるベースDN。
• ds-cfg-xasp-contains-dn: string
  エントリのDNに含まれる必要のある文字列を定義します(dc=exampleなど)。
• ds-cfg-xasp-debug(optional): boolean
  デフォルト値: false

  追加のメッセージをログに記録するかどうかを指定します。
• ds-cfg-xasp-index(optional): string
  結果の索引作成に使用される属性のカンマ区切りのリストを定義します(cnなど)。
• ds-cfg-xasp-response(optional): string
  戻される各エントリに追加される属性=値のペアのカンマ区切りリストを定義します(department=Salesなど)。
• ds-cfg-xasp-reverse-dn(optional): boolean
  デフォルト値: false

  証明書に含まれるDNを逆方向にするかどうかを定義します(dc=com,dc=example,cn=users,cn=user1など)。
• ds-cfg-xasp-ttl(optional): string
  キャッシュの有効期限をミリ秒単位で定義します。
• ds-cfg-xasp-ws-url: string
  アイデンティティ・プロバイダのWebサービスURLを定義します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-xasp-base-dn",
        "ds-cfg-xasp-contains-dn",
        "ds-cfg-xasp-ws-url",
        "ds-cfg-xasp-attribute-name",
        "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 Saml Xasp Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement",
            "type":"string"
        },
        "ds-cfg-xasp-ttl":{
            "description":"Defines the Cache Time-To-Live in milliseconds. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-xasp-base-dn":{
            "description":"Base dn to be used in case value not present in filter. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-xasp-contains-dn":{
            "description":"Defines a string that must be part of the DN of the entry, for example dc=example. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-xasp-reverse-dn":{
            "description":"Defines whether the DN contained in the certificate is reversed, for example dc=com,dc=example,cn=users,cn=user1. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-xasp-ws-url":{
            "description":"Defines the web service URL of the identity provider. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-xasp-attribute-name":{
            "description":"Defines the attribute that contains the DN of the entry in the search filter, for example certificatedn. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-xasp-debug":{
            "description":"Specifies whether to log additional messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-xasp-index":{
            "description":"Defines a comma-separated list of attributes that is used to index the results, for example cn. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-xasp-response":{
            "description":"Defines a comma-separated list of attribute=value pairs that is added to each returned entry, for example department=Sales. ",
            "readOnly":false,
            "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."
        }
    }
}

先頭に戻る