グループRESTリソースの追加、検索、比較または削除
POST
/rest/v1/admin
グループRESTリソースの追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるグループRESTリソース
ルート・スキーマ: グループRESTリソースのPOSTRequest
型:
ソースを表示
object
- assertion: string
LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes: object グループRESTリソースのプロパティ
- base: string
LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls: array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn: string
作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
- filter: string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType(required): string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
RESTメッセージ・タイプ - requiredAttributes: array requiredAttributes
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope: string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: グループRESTリソースのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-core-schema-urn(required): string
コア・リソースのスキーマ。
- ds-cfg-enabled(required): boolean
RESTリソースが有効かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
com.oracle.scim.resources.groups.GroupResource
グループRESTリソースの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-resource-add-template-basedn(required): string
リソース・タイプが追加されるbase-dnを指定します。
- ds-cfg-resource-add-template-rdn-attr-type(required): string
デフォルト値:
cn
リソース・タイプの追加時に使用されるrdn属性タイプを指定します。 - ds-cfg-resource-attr-map: array ds-cfg-resource-attr-map
TODO
- ds-cfg-resource-containers: array ds-cfg-resource-containers
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
- ds-cfg-resource-def-filter: string
デフォルト値:
objectclass=groupOfUniqueNames
TODO - ds-cfg-resource-end-point(required): string
デフォルト値:
/Groups
RESTリソース・エンドポイントURLを指定します。 - ds-cfg-resource-id-attr: string
デフォルト値:
entryUUID
リソースのID属性を指定します。 - ds-cfg-resource-name(required): string
デフォルト値:
Group
RESTリソース名を指定します。 - ds-cfg-rest-ldap-objectclasses: array ds-cfg-rest-ldap-objectclasses
TODO
- objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-resource-containers
型:
array
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: グループRESTリソースのSuccessResponse
型:
ソースを表示
object
- compareResult: boolean
LDAP比較操作の結果を示します。
- msgType(required): string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: グループRESTリソースのSearchResultEntry
型:
ソースを表示
object
- attributes(required): object グループRESTリソースのプロパティ
- dn(required): string
作成するエントリのLDAP DN。
ネストされたスキーマ: グループRESTリソースのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-core-schema-urn(required): string
コア・リソースのスキーマ。
- ds-cfg-enabled(required): boolean
RESTリソースが有効かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
com.oracle.scim.resources.groups.GroupResource
グループRESTリソースの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-resource-add-template-basedn(required): string
リソース・タイプが追加されるbase-dnを指定します。
- ds-cfg-resource-add-template-rdn-attr-type(required): string
デフォルト値:
cn
リソース・タイプの追加時に使用されるrdn属性タイプを指定します。 - ds-cfg-resource-attr-map: array ds-cfg-resource-attr-map
TODO
- ds-cfg-resource-containers: array ds-cfg-resource-containers
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
- ds-cfg-resource-def-filter: string
デフォルト値:
objectclass=groupOfUniqueNames
TODO - ds-cfg-resource-end-point(required): string
デフォルト値:
/Groups
RESTリソース・エンドポイントURLを指定します。 - ds-cfg-resource-id-attr: string
デフォルト値:
entryUUID
リソースのID属性を指定します。 - ds-cfg-resource-name(required): string
デフォルト値:
Group
RESTリソース名を指定します。 - ds-cfg-rest-ldap-objectclasses: array ds-cfg-rest-ldap-objectclasses
TODO
- objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-resource-containers
型:
array
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
ソースを表示
201レスポンス
作成済
ルート・スキーマ: グループRESTリソースのADDResponse
型:
ソースを表示
object
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: グループRESTリソースのSearchResultEntry
型:
ソースを表示
object
- attributes(required): object グループRESTリソースのプロパティ
- dn(required): string
作成するエントリのLDAP DN。
ネストされたスキーマ: グループRESTリソースのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-core-schema-urn(required): string
コア・リソースのスキーマ。
- ds-cfg-enabled(required): boolean
RESTリソースが有効かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
com.oracle.scim.resources.groups.GroupResource
グループRESTリソースの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-resource-add-template-basedn(required): string
リソース・タイプが追加されるbase-dnを指定します。
- ds-cfg-resource-add-template-rdn-attr-type(required): string
デフォルト値:
cn
リソース・タイプの追加時に使用されるrdn属性タイプを指定します。 - ds-cfg-resource-attr-map: array ds-cfg-resource-attr-map
TODO
- ds-cfg-resource-containers: array ds-cfg-resource-containers
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
- ds-cfg-resource-def-filter: string
デフォルト値:
objectclass=groupOfUniqueNames
TODO - ds-cfg-resource-end-point(required): string
デフォルト値:
/Groups
RESTリソース・エンドポイントURLを指定します。 - ds-cfg-resource-id-attr: string
デフォルト値:
entryUUID
リソースのID属性を指定します。 - ds-cfg-resource-name(required): string
デフォルト値:
Group
RESTリソース名を指定します。 - ds-cfg-rest-ldap-objectclasses: array ds-cfg-rest-ldap-objectclasses
TODO
- objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-resource-containers
型:
array
このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
ソースを表示
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode: integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message(required): string
操作に対して返されるエラー・メッセージ。
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ