21 SCIM/RESTサービスの使用

Representation State Transfer (REST)は、HTTPを介してWebサービスを構築するアーキテクチャ形式です。アイデンティティRESTサービスは、セルフサービス、ユーザー、ロール/グループ、組織およびパスワード・ポリシー管理の機能を提供するREST Webサービスのセットです。

この章では、SCIM/RESTサービスおよびREST APIの使用方法について説明します。次の項目が含まれます。

ノート:

デフォルトでは、SCIMは、HTTPとHTTPSの両方のポートで実行するように構成されています。SCIMをHTTPSポートのみで実行できるようにするには、SCIMのHTTPSのみでの実行の有効化に記載されているステップを実行してください。

21.1 SCIM/RESTサービスの概要

アイデンティティRESTサービスは、System for Cross-Domain Identity Management (SCIM)プロトコルに基づいています。

Oracle Identity Governance SCIMサービスは、「ユーザー・リソースのスキーマ属性」で説明するように、デフォルトでSCIMスキーマおよびIDM拡張機能とともに使用できます。

スキーマの取得の説明に従って、サポートされているスキーマを取得できます。

Oracle Identity Governanceをデプロイする場合、SCIMがOracle Identity GovernanceサーバーのWebアプリケーションとしてデフォルトでデプロイされます。

Oracle Identity GovernanceでのSCIM実装は、draft-ietf-scim-api-13 and draft-ietf-scim-core-schema-13に従います。IETFドラフトの詳細は、次のURLを参照してください。

http://www.simplecloud.info/

21.2 サポートされているリソースおよび操作

サポートされている操作に使用されるSCIMベースAPIは、ユーザー、組織、パスワード・ポリシー、システム・プロパティなど、様々なリソースで使用できます。

表21-1は、Oracle Identity Governanceのサポートされている操作に使用されるSCIMベースAPIを示しています。

表21-1 SCIMベースAPIおよびサポートされている操作

リソース エンドポイント 操作 スキーマURL 説明

ユーザー

/Users

GET、POST、PUT、PATCH、DELETE

urn:ietf:params:scim:schemas:core:2.0:User

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User

urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User

ユーザーの取得/追加/変更/無効化/有効化/ロック/ロック解除/削除 - identity.usermgmt.api.UserManager

ユーザー

/Me

GET、POST、PUT、PATCH

urn:ietf:params:scim:schemas:core:2.0:User

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User

urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User

自分のプロファイルの取得/変更、自分のパスワードの変更、自分のチャレンジ・レスポンスの変更 - selfservice.self.selfmgmt.api.AuthenticatedSelfService

自己登録 - UnauthenticatedSelfServiceを使用

PasswordResetterWithChallenges

/PasswordResetterWithChallenges

POST

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordResetterWithChallenges

PasswordValidator

/PasswordValidator

POST

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordValidator

UserNameGenerator

/UserNameGenerator

POST

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameGenerator

UserNameRecoverer

/UserNameRecoverer

POST

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameRecoverer

UserNameValidator

/UserNameValidator

POST

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameValidator

グループ

/Groups

GET、POST、PUT、PATCH、DELETE

urn:ietf:params:scim:schemas:core:2.0:Group

urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group

urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group

グループの取得/追加/変更/SetUserMembershipRule/削除 - identity.rolemgmt.api.RoleManager

組織

/Organizations

GET、POST、PUT、PATCH、DELETE

urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization

組織の取得/追加/変更/SetUserMembershipRule/削除 - identity.orgmgmt.api.OrganizationManager

パスワード・ポリシー

/PasswordPolicies

GET、POST、PUT、PATCH、DELETE

urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy

パスワード・ポリシーの取得/追加/変更/削除 - passwordmgmt.api.PasswordMgmtService

通知テンプレート

/NotificationTemplates

GET、POST、PUT、PATCH、DELETE

urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate

通知テンプレートの取得/追加/変更/削除 - notification.api.NotificationService

システム・プロパティ

/SystemProperties

GET、PATCH

urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:SystemProperty

システム・プロパティの取得/変更 - config.api.SystemConfigurationService

サービス・プロバイダ構成スキーマ

/ServiceProviderConfigs

GET

urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig

サービス・プロバイダの構成の取得

リソース・タイプ

/ResourceTypes

GET

urn:ietf:params:scim:schemas:core:2.0:ResourceType

リソース・タイプの構成の取得

スキーマ

/Schemas

GET

urn:ietf:params:scim:schemas:core:2.0:Schema

urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Schema

リソースのスキーマの取得

検索

[prefix]/.search

POST

該当なし

POSTを使用した1つ以上のリソース・タイプのシステム・ルートまたはリソース・エンドポイント内での検索の実行

21.3 リソース・スキーマ

リソース・スキーマとサポートされているリソースのスキーマ属性を理解します。

この項では、リソース・スキーマについて説明し、サポートされているリソースのスキーマ属性をリストします。次の項目が含まれます。

21.3.1 リソース・スキーマの概要

サポートされているSCIM属性、SCIMスキーマ属性のタイプおよび可変性を理解します。

この項にリストするリソース・スキーマの表は、サポートされるSCIM属性を示しています。すべてのSCIMリソース・タイプおよびスキーマ拡張は、JSONリクエストとレスポンスの両方で次のURIによって識別されます。

urn:oracle:scim:schemas:idm:2.0:RESOURCE_TYPE

ユーザー、グループ、組織などのすべてのSCIMリソースには、SCIMスキーマ属性の次のタイプが含まれます。

  • SVA: 単一値属性

  • MVA: 複数値属性。

  • CSVA: 複合単一値属性

  • CMVA: 複合複数値属性。

    SCIMユーザー・スキーマは、各値が個人用電子メール・アドレス、仕事用電子メール・アドレス、その他の電子メール・アドレスなどのサブ属性と値を持つことができる電子メール・アドレスなどのCMVAをサポートします。既存のOracle Identity Governanceユーザー・スキーマ属性にマップできる場合を除き、Oracle Identity GovernanceはCMVAをサポートせず、Oracle Identity Governance SCIM/REST APIもCMVAをサポートしません。Oracle Identity Governance SCIM/RESTでサポートされない複合SCIM属性を含むリクエストが行われた場合、RESTレスポンスに同じ内容を示すエラーが戻されます。

可変性は、特定の属性がアクセスされる方法です。可能な可変性値は次のとおりです。

  • 読取り専用(RO): 作成および読取り/検索操作を実行できます

  • WO: 作成はできますが、読取り/検索操作はできません

  • RW: 作成および読取り/検索操作を実行できます

21.3.2 ユーザー・リソースのスキーマ属性

ユーザー・スキーマ属性、エンタープライズ・ユーザー・スキーマ属性、IDM共通ユーザー・スキーマ属性、OIGユーザー・スキーマ拡張属性など、ユーザー・リソースのスキーマ属性を理解します。

この項では、ユーザー・リソースのスキーマ属性について説明します。次の項目が含まれます。

21.3.2.1 ユーザー・スキーマ属性
表21-2に、SCIMユーザー・スキーマ属性をリストします。

ノート:

アカウントおよびエンタイトルメントはOracle Identity Governance SCIMサービスでサポートされません。

表21-2 urn:ietf:params:scim:schemas:core:2.0:User

SCIM属性 属性タイプ データ型 必須 可変性

userName

SVA

文字列

Y

RW

name.formatted

SVA

文字列

N

RW

name.familyName

SVA

文字列

N

RW

name.givenName

SVA

文字列

N

RW

name.middleName

SVA

文字列

N

RW

name.honorificPrefix

SVA

文字列

N

RW

name.honorificSuffix

SVA

文字列

N

RW

displayName

SVA

文字列

N

RW

nickName

SVA

文字列

N

RW

profileUrl

SVA

文字列

N

RW

title

SVA

文字列

N

RW

title

SVA

文字列

N

RW

userType

SVA

文字列

N

RW

preferredLanguage

SVA

文字列

N

RW

timezone

SVA

文字列

N

RW

locale

SVA

文字列

N

RW

active

SVA

Boolean

N

RW

password

SVA

文字列

N

WO

emails

CMVA

該当なし

N

RW

emails[work].value

SVA

文字列

N

RW

emails[<type>].primary

SVA

文字列

N

RW

phoneNumbers

CMVA

該当なし

N

RW

phoneNumbers.type

SVA

文字列

N

RW

phoneNumbers[work].value

SVA

文字列

N

RW

phoneNumbers[home].value

SVA

文字列

N

RW

phoneNumbers[mobile].value

SVA

文字列

N

RW

phoneNumber[fax].value

SVA

文字列

N

RW

phoneNumber[pager].value

SVA

文字列

N

RW

phoneNumber[other].value

SVA

文字列

N

RW

ims

CMVA

該当なし

N

RW

photos

CMVA

該当なし

N

RW

addresses

CMVA

該当なし

N

RW

addresses.type

SVA

文字列

N

RW

addresses[<type>].primary

SVA

文字列

N

RW

addresses[work].formatted

SVA

文字列

N

RW

addresses[home].formatted

SVA

文字列

N

RW

addresses[work].streetAddress

SVA

文字列

N

RW

addresses[work].locality

SVA

文字列

N

RW

addresses[work].region

SVA

文字列

N

RW

addresses[work].postalCode

SVA

文字列

N

RW

addresses[work].country

SVA

文字列

N

RW

groups

CMVA

該当なし

N

RO

groups.value

SVA

文字列

N

RO

groups.$ref

SVA

文字列

N

RO

groups.type

SVA

文字列

N

RO

entitlements

SMVA

文字列

N

RW

roles

SMVA

文字列

N

RW

x509Certificates

SMVA

文字列

N

RW
21.3.2.2 エンタープライズ・ユーザー・スキーマ属性

表21-3に、SCIMエンタープライズ・ユーザー・スキーマ属性をリストします。

表21-3 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

SCIM属性 属性タイプ データ型 必須 可変性

employeeNumber

SVA

文字列

N

RW

costCenter

SVA

文字列

N

RW

organization

SVA

文字列

N

RO

division

SVA

文字列

N

RW

department

SVA

文字列

N

RW

manager.value

SVA

文字列

N

RW

manager.$ref

SVA

文字列

N

RW

manager.displayName

SVA

文字列

N

RO
21.3.2.3 IDM共通ユーザー・スキーマ拡張属性

表21-4に、SCIM IDM共通ユーザー・スキーマ拡張属性をリストします。

表21-4 urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User

SCIM属性 属性タイプ データ型 必須 可変性

createBy.value

SVA

文字列

N

RO

createBy.$ref

SVA

文字列

N

RO

updateBy.value

SVA

文字列

N

RO

updateBy.$ref

SVA

文字列

N

RO

passwd

CSVA

passwd.value

SVA

文字列

N

WO

passwd.oldValue

SVA

文字列

N

WO

passwd.sendNotification

SVA

文字列

N

WO

passwd.sendNotificationTo

SVA

文字列

N

WO

passwordMustChange

SVA

文字列

N

RO

passwordExpireDate

SVA

文字列

N

RO

locked.value

SVA

文字列

N

RW

locked.duration

SVA

文字列

N

RW

locked.reason

SVA

文字列

N

RO

locked.on

SVA

文字列

N

RO

challenges

CMVA

該当なし

N

RW

challenges.challenge

SVA

文字列

N

RW

challenges.response

SVA

文字列

N

RW
21.3.2.4 OIGユーザー・スキーマ拡張属性

表21-5に、Oracle Identity Governance (OIG)ユーザー・スキーマ拡張属性をリストします。

表21-5 urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User

SCIM属性 属性タイプ データ型 必須 可変性

dataLevel

SVA

文字列

N

RO

disabled

SVA

文字列

N

RO

passwordCreateDate

SVA

Date

N

RO

passwordCantChange

SVA

文字列

N

RO

passwordNeverExpires

SVA

文字列

N

RO

passwordIsExpired

SVA

文字列

N

RO

passwordWarnDate

SVA

Date

N

RO

lastSuccessfulLoginDate

SVA

Date

N

RO

lastFailedLoginDate

SVA

Date

N

RO

hireDate

SVA

Date

N

RW

startDate

SVA

Date

N

RW

endDate

SVA

Date

N

RW

provisioningDate

SVA

Date

N

RW

provisionedDate

SVA

Date

N

RO

deprovisioningDate

SVA

Date

N

RW

deprovisionedDate

SVA

Date

N

RO

automaticallyDeleteOn

SVA

Date

N

RO

userLoginAttemptsCounter

SVA

Int

N

RO

userPasswordResetAttemptsCounter

SVA

Int

N

RO

userMustChangePasswordAtNextLogin

SVA

文字列

N

RO

userPasswordMinAgeDate

SVA

Date

N

RO

description

SVA

文字列

N

RW

ldapCommonName

SVA

文字列

N

RW

ldapCommonNameGenerated

SVA

文字列

N

RW

ldapOrganization

SVA

文字列

N

RW

ldapOrganizationalUnit

SVA

文字列

N

RW

ldapDn

SVA

文字列

N

RW

ldapGuid

SVA

文字列

N

RW

poBox

SVA

文字列

N

RW

jobCode

SVA

文字列

N

RW

officeName

SVA

文字列

N

RW

initials

SVA

文字列

N

RW

faLanguage

SVA

文字列

N

RW

faTerritory

SVA

文字列

N

RW

embeddedHelp

SVA

文字列

N

RW

fontSize

SVA

文字列

N

RW

colorContrast

SVA

文字列

N

RW

accessibilityMode

SVA

文字列

N

RW

numberFormat

SVA

文字列

N

RW

dateFormat

SVA

文字列

N

RW

timeFormat

SVA

文字列

N

RW

currency

SVA

文字列

N

RW

summaryRisk

SVA

文字列

N

RO

hasHighRiskRole

SVA

文字列

N

RO

hasHighRiskResource

SVA

文字列

N

RO

hasHighRiskEntitlement

SVA

文字列

N

RO

hasHighRiskProvisioningMethod

SVA

文字列

N

RO

hasHighRiskOpenSod

SVA

文字列

N

RO

hasHighRiskLastCert

SVA

文字列

N

RO

roleSummaryRisk

SVA

文字列

N

RO

accountSummaryRisk

SVA

文字列

N

RO

entitlementSummaryRisk

SVA

文字列

N

RO

riskUpdateDate

SVA

文字列

N

RO

homeOrganization

CSVA

該当なし

N

RW

homeOrganization.value

SVA

文字列

N

RW

homeOrganization.$ref

SVA

文字列

N

RO

Organizations

CMVA

該当なし

N

RO

organizations.value

SVA

文字列

N

RO

organizations.$ref

SVA

文字列

N

RO

passwordPolicyDescription

SVA

文字列

N

RO

requestId

SVA

文字列

N

RO

21.3.3 PasswordResetterWithChallengesリソースのスキーマ属性

IDM PasswordResetterWithChallengesユーザー・スキーマ属性を理解します。

表21-6に、IDM PasswordResetterWithChallengesユーザー・スキーマ属性をリストします。

表21-6 urn:ietf:params:scim:schemas:oracle:core:2.0:PasswordResetterWithChallenges

SCIM属性 属性タイプ データ型 必須 可変性

userName

SVA

文字列

Y

WO

Challenges

CMVA

該当なし

Y

WO

challenges.challenge

SVA

文字列

Y

WO

challenges.response

SVA

文字列

Y

WO

password

SVA

文字列

Y

WO

21.3.4 PasswordValidatorリソースのスキーマ属性

IDM PasswordValidatorスキーマ属性を理解します。

表21-7に、IDM PasswordValidatorスキーマ属性をリストします。

表21-7 urn:ietf:params:scim:schemas:oracle:core:2.0:PasswordValidator

SCIM属性 属性タイプ データ型 必須 可変性

userRef

SVA

文字列

Y

WO

password

SVA

文字列

Y

WO

21.3.5 UserNameValidatorリソースのスキーマ属性

IDM UserNameValidatorスキーマ属性を理解します。

表21-8に、IDM UserNameValidatorスキーマ属性をリストします。

表21-8 urn:ietf:params:scim:schemas:oracle:core:2.0:UserNameValidator

SCIM属性 属性タイプ データ型 必須 可変性

userName

SVA

文字列

Y

WO

21.3.6 UserNameGeneratorリソースのスキーマ属性

IDM UserNameGeneratorスキーマ属性を理解します。

表21-9に、IDM UserNameGeneratorスキーマ属性をリストします。

表21-9 urn:ietf:params:scim:schemas:oracle:core:2.0:UserNameGenerator

SCIM属性 属性タイプ データ型 必須 可変性

name

CSVA

該当なし

Y

WO

name.formatted

SVA

文字列

Y

WO

name.familyName

SVA

文字列

Y

WO

name.givenName

SVA

文字列

Y

WO

name.middleName

SVA

文字列

Y

WO

name.honorificSuffix

SVA

文字列

Y

WO

21.3.7 UserNameRecovererリソースのスキーマ属性

IDM UserNameRecovererスキーマ属性を理解します。

表21-10に、IDM UserNameRecovererスキーマ属性をリストします。

表21-10 urn:ietf:params:scim:schemas:oracle:core:2.0:UserNameRecoverer

SCIM属性 属性タイプ データ型 必須 可変性

email

SVA

文字列

Y

WO

21.3.8 グループ・リソースのスキーマ属性

グループ・スキーマ属性、IDM共通グループ・スキーマ拡張属性、OIGグループ・スキーマ拡張属性など、グループ・リソースのスキーマ属性を理解します。

この項では、グループ・リソースのスキーマ属性について説明します。次の項目が含まれます。

21.3.8.1 グループ・スキーマ属性

表21-11に、SCIMグループ・スキーマ属性をリストします。

表21-11 urn:ietf:params:scim:schemas:core:2.0:Group

SCIM属性 属性タイプ データ型 必須 可変性

displayName

SVA

文字列

Y

RW

members

CMVA

該当なし

N

members.value

SVA

文字列

N

RW

members .$ref

SVA

文字列

N

RW
21.3.8.2 IDM共通グループ・スキーマ拡張属性

表21-12に、IDM共通グループ・スキーマ拡張属性をリストします。

表21-12 urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group

SCIM属性 属性タイプ データ型 必須 可変性

createBy.value

SVA

文字列

N

RO

createBy.$ref

SVA

文字列

N

RO

updateBy.value

SVA

文字列

N

RO

updateBy.$ref

SVA

文字列

N

RO

email

SVA

文字列

N

RW

description

SVA

文字列

N

RW

owner

CSVA

該当なし

N

RW

owner.value

SVA

文字列

N

RW

owner.$ref

SVA

文字列

N

RO

owner.firstName

SVA

文字列

N

RO

owner.lastName

SVA

文字列

N

RO

owner.displayName

SVA

文字列

N

RO

owner.email

SVA

文字列

N

RO

owner.login

SVA

文字列

N

RO
21.3.8.3 OIGグループ・スキーマ拡張属性

表21-13に、OIGグループ・スキーマ拡張属性をリストします。

表21-13 urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group

SCIM属性 属性タイプ データ型 必須 可変性

dataLevel

SVA

文字列

N

RO

namespace

SVA

文字列

N

RW

category

CSVA

該当なし

N

RW

category.value

SVA

文字列

N

RW

category.name

SVA

文字列

N

RO

ldapGuid

SVA

文字列

N

RO

ldapDn

SVA

文字列

N

RO

requestId

SVA

文字列

N

RO

accessPolicies.value

MVA

文字列

N

RW

organizationsPublishedTo

CMVA

該当なし

N

RW

organizationsPublishedTo.value

SVA

文字列

N

RW

organizationsPublishedTo.$ref

SVA

文字列

N

RO

catalog

CSVA

該当なし

N

RW

catalog.id

SVA

文字列

N

RO

catalog.categoryName

SVA

文字列

N

RW

catalog.auditObjectives

SVA

文字列

N

RW

catalog.itemRisk

SVA

Integer

N

RW

catalog.userDefinedTags

SVA

文字列

N

RW

catalog.certifiable

SVA

Boolean

N

RW

catalog.auditable

SVA

Boolean

N

RW

catalog.requestable

SVA

Boolean

N

RW

catalog.tags

SVA

文字列

N

RO

catalog.hierarchicalDataAvailable

SVA

Boolean

N

RO

catalogApproverUser.value

SVA

文字列

N

RW

catalogApproverUser.$ref

SVA

Reference

N

RW

catalogApproverRole.value

SVA

文字列

N

RW

catalogApproverRole.$ref

SVA

Reference

N

RW

catalogCertifierUser.value

SVA

文字列

N

RW

catalogCertifierUser.$ref

SVA

Reference

N

RW

catalogCertifierRole.value

SVA

文字列

N

RW

catalogCertifierRole.$ref

SVA

Reference

N

RW

catalogFulfillmentUser.value

SVA

文字列

N

RW

catalogFulfillmentUser.$ref

SVA

Reference

N

RW

catalogFulfillmentRole.value

SVA

文字列

N

RW

catalogFulfillmentRole.$ref

SVA

Reference

N

RW

catalogAttributes

CMVA

該当なし

N

RW

catalogAttributes.name

SVA

文字列

N

RW

catalogAttributes.value

SVA

文字列

N

RW

catalogAttributes.udf

SVA

Boolean

N

RW

catalogAttributes.description

SVA

文字列

N

RW

catalogAttributes.searchable

SVA

Boolean

N

RW

catalogAttributes.sortable

SVA

Boolean

N

RW

catalogAttributes.certifiable

SVA

Boolean

N

RW

catalogAttributes.datatype

SVA

文字列

N

RO

userMembershipRule

CSVA

該当なし

N

RW

userMembershipRule.value

SVA

文字列

N

RW

userMembershipRule.evaluate

SVA

Boolean

N

WO

21.3.9 組織リソースのスキーマ属性

OIG組織スキーマ属性を理解します。

表21-14に、OIG組織スキーマ属性をリストします。

表21-14 urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization

SCIM属性 属性タイプ データ型 必須 可変性

createBy.value

SVA

文字列

N

RO

createBy.$ref

SVA

文字列

N

RO

updateBy.value

SVA

文字列

N

RO

updateBy.$ref

SVA

文字列

N

RO

dataLevel

SVA

文字列

N

RO

name

SVA

文字列

N

RW

customerType

SVA

文字列

N

RW

status

SVA

文字列

N

RW

disabled

SVA

文字列

N

RW

parent

CSVA

該当なし

N

RW

parent.value

SVA

文字列

N

RW

parent.$ref

SVA

文字列

N

RO

parent.name

SVA

文字列

N

RO

passwordPolicy

CSVA

該当なし

N

RW

passwordPolicy.value

SVA

文字列

N

RW

passwordPolicy.$ref

SVA

文字列

N

RO

passwordPolicy.name

SVA

文字列

N

RO

certifierUser

CSVA

該当なし

N

RW

certifierUser.value

SVA

文字列

N

RW

certifierUser.$ref

SVA

文字列

N

RO

certifierUser.login

SVA

文字列

N

RO

enforceNewPasswordPolicy

SVA

文字列

N

RW

userMembershipRule

CSVA

該当なし

N

RW

userMembershipRule.value

SVA

文字列

N

RW

userMembershipRule.evaluate

SVA

文字列

N

WO

members

CMVA

該当なし

N

RO

members.value

SVA

文字列

N

RO

members.$ref

SVA

文字列

N

RO

childOrganizations

CSVA

該当なし

N

RO

childOrganizations.value

SVA

文字列

N

RO

childOrganizations.$ref

SVA

Reference

N

RO

21.3.10 パスワード・ポリシー・リソースのスキーマ属性

IDMパスワード・ポリシー・スキーマ属性を理解します。

表21-15に、IDMパスワード・ポリシー・スキーマ属性をリストします。

表21-15 urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy

SCIM属性 属性タイプ データ型 必須 可変性

name

SVA

文字列

N

RW

description

SVA

文字列

N

RW

maxLength

SVA

文字列

N

RW

minLength

SVA

文字列

N

RW

minAlphas

SVA

文字列

N

RW

minNumerals

SVA

文字列

N

RW

minAlphaNumerals

SVA

文字列

N

RW

minSpecialChars

SVA

文字列

N

RW

maxSpecialChars

SVA

文字列

N

RW

minUpperCase

SVA

文字列

N

RW

minLowerCase

SVA

文字列

N

RW

minUniqueChars

SVA

文字列

N

RW

maxRepeatedChars

SVA

文字列

N

RW

startsWithAlphabet

SVA

文字列

N

RW

minUnicodeChars

SVA

文字列

N

RW

maxUnicodeChars

SVA

文字列

N

RW

firstNameDisallowed

SVA

文字列

N

RW

lastNameDisallowed

SVA

文字列

N

RW

userIdDisallowed

SVA

文字列

N

RW

minPasswordAgeInDays

SVA

文字列

N

RW

passwordWarningAfterInDays

SVA

文字列

N

RW

passwordExpiresAfterInDays

SVA

文字列

N

RW

requiredChars

SVA

文字列

N

RW

disallowedChars

SVA

文字列

N

RW

allowedChars

SVA

文字列

N

RW

disallowedSubstrings

SVA

文字列

N

RW

dictionaryLocation

SVA

文字列

N

RW

dictionaryDelimiter

SVA

文字列

N

RW

numPasswordsInHistory

SVA

文字列

N

RW

maxIncorrectAttempts

SVA

文字列

N

RW

lockoutDuration

SVA

文字列

N

RW

complexPolicy

SVA

文字列

N

RW

challengesEnabled

SVA

文字列

N

RW

challengeSource

SVA

文字列

N

RW

challengeDefaultQuestions.value

SVA

文字列

N

RW

challengeMinQuestions

SVA

文字列

N

RW

challengeMinAnswers

SVA

文字列

N

RW

challengeAllAtOnce

SVA

文字列

N

RW

challengeResponseMinLength

SVA

文字列

N

RW

challengeAllowDuplicateResponses

SVA

文字列

N

RW

challengeMaxIncorrectAttempts

SVA

文字列

N

RW

21.3.11 通知テンプレート・リソースのスキーマ属性

OIG通知テンプレート・スキーマ属性を理解します。

表21-16に、OIG通知テンプレート・スキーマ属性をリストします。

表21-16 urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate

SCIM属性 属性タイプ データ型 必須 可変性

name

SVA

文字列

Y

RW

eventName

SVA

文字列

Y

RW

description

SVA

文字列

N

RW

locales

CMVA

該当なし

N

RW

locales.locale

SVA

文字列

Y

RW

locales.encoding

SVA

文字列

Y

RW

locales .subject

SVA

文字列

Y

RW

locales .contentType

SVA

文字列

Y

RW

locales.shortMessage

SVA

文字列

N

RW

locales.longMessage

SVA

文字列

Y

RW

21.3.12 システム・プロパティ・リソースのスキーマ属性

OIGシステム・プロパティ・スキーマ属性を理解します。

表21-17に、OIGシステム・プロパティ・スキーマ属性をリストします。

表21-17 urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:SystemProperty

SCIM属性 属性タイプ データ型 必須 可変性

name

SVA

文字列

Y

RW

displayName

SVA

文字列

N

RW

value

SVA

文字列

N

RW

21.3.13 サービス・プロバイダ構成スキーマ・リソースのスキーマ属性

SCIMサービス・プロバイダ構成スキーマ属性を理解します。

表21-18に、SCIMサービス・プロバイダ構成スキーマ属性をリストします。

表21-18 urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig

SCIM属性 属性タイプ データ型 必須 可変性

documentationUrl

SVA

文字列

N

RO

patch.supported

SVA

Boolean

N

RO

bulk.supported

SVA

Boolean

N

RO

bulk.maxOperations

SVA

Integer

N

RO

bulk.maxPayloadSize

SVA

Integer

N

RO

filter.supported

SVA

Boolean

N

RO

filter.maxResults

SVA

Integer

N

RO

changePassword.supported

SVA

Boolean

N

RO

sort.supported

SVA

Boolean

N

RO

Etag.supported

SVA

Boolean

N

RO

authenticationSchemes.name

SVA

文字列

N

RO

authenticationSchemes.description

SVA

文字列

N

RO

authenticationSchemes.specUrl

SVA

文字列

N

RO

authenticationSchemes.documentationUrl

SVA

文字列

N

RO

21.3.14 リソース・タイプ・リソースのスキーマ属性

SCIMリソース・タイプ・スキーマ属性を理解します。

表21-19に、SCIMリソース・タイプ・スキーマ属性をリストします。

表21-19 urn:ietf:params:scim:schemas:core:2.0:ResourceType

SCIM属性 属性タイプ データ型 必須 可変性

name

SVA

文字列

N

RO

description

SVA

文字列

N

RO

endpoint

SVA

文字列

N

RO

schema

SVA

文字列

N

RO

schemaExtensions.schema

SVA

文字列

N

RO

schemaExtensions.required

SVA

Boolean

N

RO

21.3.15 スキーマ・リソースのスキーマ属性

SCIMスキーマ属性、OIGスキーマ拡張属性など、スキーマ・リソースのスキーマ属性を理解します。

この項では、スキーマ・リソースのスキーマ属性について説明します。次の項目が含まれます。

21.3.15.1 SCIMスキーマ属性

表21-20に、SCIMスキーマの属性をリストします。

表21-20 urn:ietf:params:scim:schemas:core:2.0:Schema

SCIM属性 属性タイプ データ型 必須 可変性

id

SVA

文字列

N

RO

name

SVA

文字列

N

RO

description

SVA

文字列

N

RO

attributes.name

SVA

文字列

N

RO

attributes.type

SVA

文字列

N

RO

attributes.multiValued

SVA

文字列

N

RO

attributes.description

SVA

文字列

N

RO

attributes.readOnly

SVA

Boolean

N

RO

attributes.required

SVA

Boolean

N

RO

attributes.mutability

SVA

文字列

N

RO

attributes.returned

SVA

文字列

N

RO

attributes.uniqueness

SVA

文字列

N

RO

attributes.caseExact

SVA

Boolean

N

RO
21.3.15.2 OIGスキーマ拡張属性

表21-21に、OIGスキーマのスキーマ拡張属性をリストします。

表21-21 urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Schema

SCIM属性 属性タイプ データ型 必須 可変性

attributes.indexes

SVA

文字列

N

RO

21.4 操作タイプ

サポートされている操作タイプは、GET、POST、PUT、PATCHおよびDELETEです。

次の操作タイプがサポートされています。

  • GET: 1つ以上の完全または部分リソースを取得します。

  • POST: エンドポイントに応じて、新規リソースを作成するか、検索リクエストを作成します。

  • PUT: 既存の属性を指定した置換属性のセット(replace)で置換することでリソースを変更します。PUTを使用して新規リソースを作成する必要があります。

  • PATCH: クライアントが指定した変更のセット(partial updates)でリソースを変更します。

  • DELETE: リソースを削除します。

操作タイプの詳細は、次のURLを参照してください。

https://tools.ietf.org/html/draft-ietf-scim-api-13#page-5

21.5 HTTPレスポンス・コード

HTTPレスポンス・コードを返すことに加えて、アイデンティティRESTサービスはレスポンスの本文内のエラーをエラー・コードと説明とともに返します。

この項では、エラー・コード、成功コードおよびその意味をリストします。次の項目が含まれます。

21.5.1 エラー・コード

エラー状態、HTTPリターン・コードおよびその意味を理解します。

表21-22に、エラー・コードとその意味をリストします。

表21-22 エラー・コードと意味

エラー状態 HTTPリターン・コード 意味

入力を解析できない、入力が必要なエンティティと一致しない、または検証失敗

400

不正なリクエスト: 検証失敗、スキーマ違反

リクエスト・リソースが見つからない

404

ADDITIONAL_INFORMATION_INDICATING_NOT_FOUND_OBJECTが見つからない

ユーザーにアクティビティの実行権限がない。

401

未認可

リクエストされたメソッドがサポートされていない。

501

使用できないメソッド

作成されたコンテンツ・タイプをクライアントが受け付けない。

406

受入れ不可

リクエスト・パラメータのセマンティックが正しくない

422

処理不能なエンティティ。ADDITIONAL_INFORMATION_ON_NATURE_OF_ERROR

クライアント・メディア・タイプがサポートされていない。

415

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

依存性のエラーが発生

424

依存性のエラーが発生。ADDITIONAL_INFORMATION_ON_FAILED_DEPENDENCY

汎用的なサーバー・エラー

500

内部サーバー・エラー

競合

409

指定したバージョン番号が一致しないか、リソースの最新バージョン番号またはサービス・プロバイダが新しい重複リソースの作成を拒否

事前の条件設定に失敗

412

サーバーで最後に取得されたリソースIDが変更されたため、更新に失敗

禁止

403

サーバーは指定されたリソースでリクエストされた操作をサポートしていない

21.5.2 成功コード

成功した操作のHTTPリターン・コードとその意味を理解します。

表21-23に、成功コードとその意味をリストします。

表21-23 成功コードと意味

HTTPリターン・コード 意味

200

正常に処理されました。

201

リクエストが完了し、新規のリソースが作成されました。

204

サーバーはリクエストを実行しましたが、レスポンス本文を返しません。

21.6 SCIMベースAPIの例

SCIMベースAPIは、セルフ・サービス、エンティティ管理、システム・プロパティ管理など、様々なタイプの操作に使用できます。

この項では、次のSCIMベースAPIの使用例を示します。

ノート:

SCIMリクエストでユーザー定義フィールド(UDF)を使用できます。UDFがOracle Identity Governanceに作成された後、これらはSCIMリソースに通常の属性として自動的に表示されます。通常の属性を持つリクエストとレスポンスに違いはありません。

21.6.1 ユーザー管理

ユーザー・リソースに関するSCIMベースAPIの使用例を理解します。

この項では、ユーザー・リソースの次の例を示します。

21.6.1.1 ユーザーの作成

この項では、POST操作タイプを使用した「ユーザーの作成」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.1.1 「ユーザーの作成」のリクエスト

「ユーザーの作成」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/Users

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User"
  ],
  "userName": "bjensen@example.com",
  "name": {
    "familyName": "Jensen",
    "givenName": "Barbara",
    "middleName": "Jane",
    "honorificSuffix": "III"
  },
  "displayName": "Babs Jensen",
  "profileUrl": "https://HOST_NAME:PORT/bjensen",
  "emails":
  [
    {
      "value": "bjensen@example.com",
      "type": "work"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "streetAddress": "100 Universal City Plaza",
      "locality": "Hollywood",
      "region": "CA",
      "postalCode": "91608",
      "country": "USA",
      "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA"
    },
    {
      "type": "home",
      "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA"
    }
  ],
  "phoneNumbers": [
    {
      "value": "555-555-5555",
      "type": "work"
    },
    {
      "value": "555-555-4444",
      "type": "mobile"
    }
  ],
  "userType": "Contractor",
  "title": "Tour Guide",
  "preferredLanguage":"en-US",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":
  {
    "employeeNumber": "701984",
    "costCenter": "4130",
    "division": "Theme Park",
    "department": "Tour Operations",
    "manager":
    {
      "value": "1",
      "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    }
  },
  "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User":
  {
    "homeOrganization":
    {
      "value": "1",
      "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
    }
  }
}
21.6.1.1.2 「ユーザーの作成」のレスポンス

「ユーザーの作成」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": 
    [
       "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
       "urn:ietf:params:scim:schemas:core:2.0:User",
       "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User",
       "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "userLoginAttemptsCounter": 0,
        "passwordIsExpired": "0",
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "passwordWarnDate": "2015-04-29T03:24:16.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordCreateDate": "2015-01-06T03:24:16.000-08:00",
        "provisionedDate": "2015-01-06T03:24:16.000-08:00",
        "passwordPolicyDescription": [],
        "userMustChangePasswordAtNextLogin": "1",
        "disabled": false,
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ]
    },
    "displayName": "Babs Jensen",
    "id": "145",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-05-06T03:24:16.000-07:00",
        "locked": {
            "duration": 0,
            "value": "0",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/0"
        }
    },
    "userName": "BJENSEN@EXAMPLE.COM",
    "emails": [
        {
            "value": "bjensen@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Contractor",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "701984",
        "manager": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance//v1/Users/1",
            "displayName": "new display"
        },
        "department": "Tour Operations",
        "organization": "Xellerate Users"
    },
    "preferredLanguage": "en-US",
    "phoneNumbers": [
        {
            "value": "555-555-4444",
            "type": "mobile"
        },
        {
            "value": "555-555-5555",
            "type": "work"
        }
    ],
    "name": {
        "middleName": "Jane",
        "familyName": "Jensen",
        "givenName": "Barbara",
        "honorificSuffix": "III"
    },
    "addresses": [
        {
            "region": "CA",
            "streetAddress": "100 Universal City Plaza",
            "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
            "postalCode": "91608",
            "locality": "Hollywood",
            "country": "USA",
            "type": "work"
        },
        {
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "type": "home"
        }
    ],
    "groups": [
        {
            "value": "3",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/3",
            "type": "direct"
        }
    ],
    "timezone": "America/Los_Angeles",
    "title": "Tour Guide",
    "meta": {
        "lastModified": "2015-01-06T03:24:17.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/145",
        "created": "2015-01-06T03:24:17.000-08:00",
        "resourceType": "User"
    }
}
21.6.1.2 ユーザーの変更(PUT)

この項では、PUT操作タイプを使用した「ユーザーの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.2.1 「ユーザーの変更」(PUT)のリクエスト

「ユーザーの変更」操作(PUT)のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/Users/355

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":    
  [       
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",        
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",       
    "urn:ietf:params:scim:schemas:core:2.0:User"   
  ],   
  "userName": "userName_user216_08_09.382323",   
  "name":    
  {       
    "familyName": "familyName2_user216_08_09.382323"   
  },   
  "userType": "Contractor",   
  "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User":    
  {       
    "description": "description2_user216_08_09.382323"   
  },   
  "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User":    
  {       
      "homeOrganization":       
    {           
      "value": "4",           
      "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/4"       
    }   
  }
}
21.6.1.2.2 「ユーザーの変更」(PUT)のレスポンス

「ユーザーの変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "passwordIsExpired": "0",
        "userLoginAttemptsCounter": 0,
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "passwordWarnDate": "2015-07-02T08:46:57.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordCreateDate": "2015-03-11T08:46:57.000-07:00",
        "provisionedDate": "2015-03-11T08:46:57.000-07:00",
        "passwordPolicyDescription": [
            {
                "value": "Password must not match or contain first name."
            },
            {
                "value": "Password must not match or contain last name."
            },
            {
                "value": "Password must contain at least 2 alphabetic character(s)."
            },
            {
                "value": "Password must be at least 6 character(s) long."
            },
            {
                "value": "Password must contain at least 1 lowercase letter(s)."
            },
            {
                "value": "Password must contain at least 1 numeric character(s)."
            },
            {
                "value": "Password must contain at least 1 uppercase letter(s)."
            },
            {
                "value": "Password must start with an alphabetic character."
            },
            {
                "value": "Password must not match or contain user ID."
            }
        ],
        "userMustChangePasswordAtNextLogin": "1",
        "disabled": false,
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ],
        "description": "description2_user216_08_09.382323"
    },
    "displayName": "Babs Jensen",
    "id": "355",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-07-09T08:46:57.000-07:00",
        "locked": {
            "duration": 0,
            "value": "0"
        }
    },
    "userName": "USERNAME_USER216_08_09.382323",
    "emails": [
        {
            "value": "u1@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Contractor",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "701984",
        "manager": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "displayName": "display"
        },
        "department": "Tour Operations",
        "organization": "Xellerate Users"
    },
    "preferredLanguage": "en-US",
    "phoneNumbers": [
        {
            "value": "555-555-4444",
            "type": "mobile"
        },
        {
            "value": "555-555-5555",
            "type": "work"
        }
    ],
    "name": {
        "middleName": "Jane",
        "familyName": "familyName2_user216_08_09.382323",
        "givenName": "Barbara",
        "honorificSuffix": "III"
    },
    "addresses": [
        {
            "region": "CA",
            "streetAddress": "100 Universal City Plaza",
            "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
            "postalCode": "91608",
            "locality": "Hollywood",
            "country": "USA",
            "type": "work"
        },
        {
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "type": "home"
        }
    ],
    "groups": [
        {
            "value": "3",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/3",
            "type": "direct"
        }
    ],
    "timezone": "America/Los_Angeles",
    "title": "Tour Guide",
    "meta": {
        "lastModified": "2015-03-11T08:47:19.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/355",
        "created": "2015-03-11T08:46:57.000-07:00",
        "resourceType": "User"
    }
}
21.6.1.3 ユーザーの変更(PATCH)

この項では、PATCH操作タイプを使用した「ユーザーの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.3.1 「ユーザーの変更」(PATCH)のリクエスト

「ユーザーの変更」操作(PATCH)のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Users/355

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace",
      "path":"urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User:description,
      "value":"description3"      
    }   
  ]
}
21.6.1.3.2 「ユーザーの変更」(PATCH)のレスポンス

「ユーザーの変更」(PATCH)のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "passwordIsExpired": "0",
        "userLoginAttemptsCounter": 0,
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "passwordWarnDate": "2015-07-02T08:46:57.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordCreateDate": "2015-03-11T08:46:57.000-07:00",
        "provisionedDate": "2015-03-11T08:46:57.000-07:00",
        "passwordPolicyDescription": [
            {
                "value": "Password must not match or contain first name."
            },
            {
                "value": "Password must not match or contain last name."
            },
            {
                "value": "Password must contain at least 2 alphabetic character(s)."
            },
            {
                "value": "Password must be at least 6 character(s) long."
            },
            {
                "value": "Password must contain at least 1 lowercase letter(s)."
            },
            {
                "value": "Password must contain at least 1 numeric character(s)."
            },
            {
                "value": "Password must contain at least 1 uppercase letter(s)."
            },
            {
                "value": "Password must start with an alphabetic character."
            },
            {
                "value": "Password must not match or contain user ID."
            }
        ],
        "userMustChangePasswordAtNextLogin": "1",
        "disabled": false,
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ],
        "description": "description3"
    },
    "displayName": "Babs Jensen",
    "id": "355",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-07-09T08:46:57.000-07:00",
        "locked": {
            "duration": 0,
            "value": "0"
        }
    },
    "userName": "USERNAME_USER216_08_09.382323",
    "emails": [
        {
            "value": "u1@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Contractor",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "701984",
        "manager": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "displayName": "display"
        },
        "department": "Tour Operations",
        "organization": "Xellerate Users"
    },
    "preferredLanguage": "en-US",
    "phoneNumbers": [
        {
            "value": "555-555-4444",
            "type": "mobile"
        },
        {
            "value": "555-555-5555",
            "type": "work"
        }
    ],
    "name": {
        "middleName": "Jane",
        "familyName": "familyName2_user216_08_09.382323",
        "givenName": "Barbara",
        "honorificSuffix": "III"
    },
    "addresses": [
        {
            "region": "CA",
            "streetAddress": "100 Universal City Plaza",
            "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
            "postalCode": "91608",
            "locality": "Hollywood",
            "country": "USA",
            "type": "work"
        },
        {
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "type": "home"
        }
    ],
    "groups": [
        {
            "value": "3",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/3",
            "type": "direct"
        }
    ],
    "timezone": "America/Los_Angeles",
    "title": "Tour Guide",
    "meta": {
        "lastModified": "2015-03-11T08:49:17.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/355",
        "created": "2015-03-11T08:46:57.000-07:00",
        "resourceType": "User"
    }
}
21.6.1.4 ページ区切りでのユーザーの表示

この項では、GET操作タイプを使用した「ページ区切りでのユーザーの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.4.1 「ページ区切りでのユーザーの表示」のリクエスト

「ページ区切りでのユーザーの表示」操作のリクエストは次のとおりです。

操作とURI: GET /Users http://HOST_NAME:PORT/iam/governance/scim/v1/Users?attributes=id&startIndex=6&count=5

21.6.1.4.2 「ページ区切りでのユーザーの表示」のレスポンス

「ページ区切りでのユーザーの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文: 

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 5,
    "itemsPerPage": 5,
    "startIndex": 6,
    "Resources": [
        {
            "id": "59"
        },
        {
            "id": "42"
        },
        {
            "id": "25"
        },
        {
            "id": "106"
        },
        {
            "id": "89"
        }
    ]
}
21.6.1.4.3 検索フィルタの例

次に、検索のフィルタの例を示します。

http://HOST_NAME:PORT/iam/governance/scim/v1/Users?filter=(userName co xel)&attributes=id

http://HOST_NAME:PORT/iam/governance/scim/v1/Users?attributes=userName&filter=(userName co 4) and (userName co BUG)

http://HOST_NAME:PORT/iam/governance/scim/v1/Users?attributes=userName&filter=(emails.type eq work and emails.value sw u)

ノート:

検索フィルタの詳細な説明は、次のURLにあるSCIM REST API IETFドラフトのフィルタリングに関する項を参照してください。

https://tools.ietf.org/html/draft-ietf-scim-api-14#section-3.2.2.2

21.6.1.5 ユーザーの削除

この項では、DELETE操作タイプを使用した「ユーザーの削除」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.5.1 「ユーザーの削除」のリクエスト

「ユーザーの削除」操作のリクエストの内容は次のとおりです。

操作とURI: DELETE http://HOST_NAME:PORT/iam/governance/scim/v1/Users/355

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文: NA

21.6.1.5.2 「ユーザーの削除」のレスポンス

「ユーザーの削除」操作のレスポンスの内容は次のとおりです。

ステータス: 204 No Content

本文: NA

21.6.1.6 ユーザーのロック

この項では、PATCH操作タイプを使用した「ユーザーのロック」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.6.1 「ユーザーのロック」のリクエスト

「ユーザーのロック」操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Users/356

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
  {
    "op":"replace",
    "path":"urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User:locked",
    "value" :
      {
        "value" : 1,
        "duration" : 3600
      }
  }
  ]
}
21.6.1.6.2 「ユーザーのロック」のレスポンス

「ユーザーのロック」操作のレスポンスでは、ロック属性を更新した完全なリソースが返されます。

ステータス: HTTP/1.1 200 OK

21.6.1.7 ユーザーのロック解除

この項では、PATCH操作タイプを使用した「ユーザーのロック解除」操作のリクエストとレスポンスを紹介します。次の項目が含まれます。

21.6.1.7.1 「ユーザーのロック解除」のリクエスト

「ユーザーのロック解除」操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Users/356

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
  {
    "op":"replace",
    "path":"urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User:locked",
    "value" :
      {
        "value" : 0
      }
  }
]
}
21.6.1.7.2 「ユーザーのロック解除」のレスポンス

「ユーザーのロック解除」操作のレスポンスでは、ロック属性を更新した完全なリソースが返されます。

ステータス: HTTP/1.1 200 OK

21.6.1.8 新しいパスワードの指定によるパスワードのリセット

この項では、PATCH操作タイプを使用した「新しいパスワードの指定によるパスワードのリセット」操作のリクエストとレスポンスを紹介します。次の項目が含まれます。

21.6.1.8.1 「新しいパスワードの指定によるパスワードのリセット」のリクエスト

「新しいパスワードの指定によるパスワードのリセット」操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Users/356

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
      "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
      "Operations": [
              {
                    "op": "replace","path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User:passwd",
                    "value" :
                  {
                        "value": "newPassw0rd",
                        "sendNotification": "true",
                        "sendNotificationTo": "example2@example.com"
                  }
 
            }
      ]
 
}
21.6.1.8.2 「新しいパスワードの指定によるパスワードのリセット」のレスポンス

「新しいパスワードの指定によるパスワードのリセット」操作のレスポンスには、変更されたリソースが含まれます。

ステータス: HTTP/1.1 200 OK

21.6.1.9 自動生成済パスワードによるパスワードのリセット

この項では、PATCH操作タイプを使用した「自動生成済パスワードによるパスワードのリセット」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.9.1 「自動生成済パスワードによるパスワードのリセット」のリクエスト

「自動生成済パスワードによるパスワードのリセット」のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Users/356

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
      "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
      "Operations": [
              {
                    "op": "replace", "path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User:passwd",
                    "value":
                  {
                        "value": "auto-generate",
                        "sendNotification": "true",
                        "sendNotificationTo": "john.doe@example.com"
                  }
 
            }
      ]
 
}
21.6.1.9.2 「自動生成済パスワードによるパスワードのリセット」のレスポンス

「自動生成済パスワードによるパスワードのリセット」操作のレスポンスは、変更されたリソースです。

ステータス: HTTP/1.1 200 OK

21.6.1.10 ユーザーの表示

この項では、GET操作タイプを使用した「ユーザーの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.10.1 「ユーザーの表示」のリクエスト

「ユーザーの表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/Me

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

21.6.1.10.2 「ユーザーの表示」のレスポンス

「ユーザーの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "userLoginAttemptsCounter": 0,
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "ldapCommonName": "System Administrator",
        "passwordWarnDate": "2015-06-30T01:51:27.000-07:00",
        "lastSuccessfulLoginDate": "2015-03-11T00:00:00.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordPolicyDescription": [
            {
                "value": "Password must not match or contain first name."
            },
            {
                "value": "Password must not match or contain last name."
            },
            {
                "value": "Password must contain at least 2 alphabetic character(s)."
            },
            {
                "value": "Password must be at least 6 character(s) long."
            },
            {
                "value": "Password must contain at least 1 lowercase letter(s)."
            },
            {
                "value": "Password must contain at least 1 numeric character(s)."
            },
            {
                "value": "Password must contain at least 1 uppercase letter(s)."
            },
            {
                "value": "Password must start with an alphabetic character."
            },
            {
                "value": "Password must not match or contain user ID."
            }
        ],
        "disabled": false,
        "dataLevel": "2",
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ]
    },
    "displayName": "display",
    "id": "1",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-07-07T01:51:27.000-07:00",
        "locked": {
            "value": "0"
        }
    },
    "userName": "XELSYSADM",
    "emails": [
        {
            "value": "donotreply@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Full-Time",
    "name": {
        "familyName": "Administrator",
        "givenName": "System"
    },
    "groups": [
        {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/1",
            "type": "direct"
        },
        {
            "value": "6",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/6",
            "type": "direct"
        }
    ],
    "meta": {
        "lastModified": "2015-03-11T08:15:44.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Me",
        "created": "2015-03-09T01:51:27.000-07:00",
        "resourceType": "User"
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "organization": "Xellerate Users"
    }
}
21.6.1.11 自己登録

この項では、POST操作タイプを使用した「自己登録」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.11.1 「自己登録」のリクエスト

「自己登録」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/Me

ヘッダー:

  • Content-Type: application/scim+json

  • Authorization: NA

  • X-Requested-By: <random_value>

本文:

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
              "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User",
              "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
              "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
  "userName": "bjensen@example.com",
  "name": {
    "familyName": "Jensen",
    "givenName": "Barbara",
    "middleName": "Jane",
    "honorificSuffix": "III"
  },
  "displayName": "Babs Jensen",
  "emails": [
    {
      "value": "bjensen@example.com",
      "type": "work"
    }
  ],
  "userType": "Full-Time",
  "password":"t1meMa$heen",
  "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
    "challenges": [
        {
            "challenge":"What is your favorite color?",
            "response":"color"
        },
        {
            "challenge":"What is the name of your pet?",
            "response":"pet"
        },
        {
            "challenge":"What is the city of your birth?",
            "response":"city"
        }
    ]
  }
}
21.6.1.11.2 「自己登録」のレスポンス

「自己登録」操作のレスポンスとして、ユーザーが直接作成され、新しいユーザーのentityIdが返されます。

ステータス: HTTP/1.1 201 Created

21.6.1.12 セルフ・プロファイルの変更(PATCH)

この項では、PATCH操作タイプを使用した「セルフ・プロファイルの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.12.1 「セルフ・プロファイルの変更」(PATCH)のリクエスト

「セルフ・プロファイルの変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Me

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations":[
  {
  "op":"replace",
  "path":"displayName",
  "value" : "NEW_NAME"
  }
]
}
21.6.1.12.2 「セルフ・プロファイルの変更」(PATCH)のレスポンス

「セルフ・プロファイルの変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "userLoginAttemptsCounter": 0,
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "ldapCommonName": "System Administrator",
        "passwordWarnDate": "2015-06-30T01:51:27.000-07:00",
        "lastSuccessfulLoginDate": "2015-03-11T00:00:00.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordPolicyDescription": [
            {
                "value": "Password must not match or contain first name."
            },
            {
                "value": "Password must not match or contain last name."
            },
            {
                "value": "Password must contain at least 2 alphabetic character(s)."
            },
            {
                "value": "Password must be at least 6 character(s) long."
            },
            {
                "value": "Password must contain at least 1 lowercase letter(s)."
            },
            {
                "value": "Password must contain at least 1 numeric character(s)."
            },
            {
                "value": "Password must contain at least 1 uppercase letter(s)."
            },
            {
                "value": "Password must start with an alphabetic character."
            },
            {
                "value": "Password must not match or contain user ID."
            }
        ],
        "disabled": false,
        "dataLevel": "2",
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ]
    },
    "displayName": "NEW_NAME",
    "id": "1",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-07-07T01:51:27.000-07:00",
        "locked": {
            "value": "0"
        }
    },
    "userName": "XELSYSADM",
    "emails": [
        {
            "value": "donotreply@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Full-Time",
    "name": {
        "familyName": "Administrator",
        "givenName": "System"
    },
    "groups": [
        {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/1",
            "type": "direct"
        },
        {
            "value": "6",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/6",
            "type": "direct"
        }
    ],
    "meta": {
        "lastModified": "2015-03-11T08:55:23.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Me",
        "created": "2015-03-09T01:51:27.000-07:00",
        "resourceType": "User"
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "organization": "Xellerate Users"
    }
}
21.6.1.13 プロファイルの変更(PUT)

この項では、PUT操作タイプを使用した「プロファイルの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.13.1 「プロファイルの変更」(PUT)のリクエスト

「プロファイルの変更」(PUT)操作のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/Me

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":    
  [       
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",        
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",       
    "urn:ietf:params:scim:schemas:core:2.0:User"   
  ],   
  "userName": "bjensen@example.com",   
  "name":    
  {       
    "familyName": "Jensen"   
  },   
  "userType": "Contractor",      
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":    
  {       
    "organization": "Xellerate Users",       
    "homeOrganization":       
    {           
      "value": "1",           
      "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"       
    }   
  }
}
21.6.1.13.2 「プロファイルの変更」(PUT)のレスポンス

「プロファイルの変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": 
    [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:User": {
        "userLoginAttemptsCounter": 0,
        "passwordIsExpired": "0",
        "ldapCommonNameGenerated": 0,
        "userPasswordResetAttemptsCounter": 0,
        "passwordWarnDate": "2015-04-29T03:24:16.000-07:00",
        "homeOrganization": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1"
        },
        "passwordCreateDate": "2015-01-06T03:24:16.000-08:00",
        "provisionedDate": "2015-01-06T03:24:16.000-08:00",
        "passwordPolicyDescription": [],
        "userMustChangePasswordAtNextLogin": "1",
        "disabled": false,
        "organizations": [
            {
                "value": "1",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/1",
                "display": "Xellerate Users"
            }
        ]
    },
    "displayName": "Babs Jensen",
    "id": "145",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:User": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "passwordExpireDate": "2015-05-06T03:24:16.000-07:00",
        "locked": {
            "duration": 0,
            "value": "0",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/0"
        }
    },
    "userName": "BJENSEN@EXAMPLE.COM",
    "emails": [
        {
            "value": "bjensen@example.com",
            "type": "work"
        }
    ],
    "active": true,
    "userType": "Contractor",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "701984",
        "manager": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "displayName": "new display"
        },
        "department": "Tour Operations",
        "organization": "Xellerate Users"
    },
    "preferredLanguage": "en-US",
    "phoneNumbers": [
        {
            "value": "555-555-4444",
            "type": "mobile"
        },
        {
            "value": "555-555-5555",
            "type": "work"
        }
    ],
    "name": {
        "middleName": "Jane",
        "familyName": "Jensen",
        "givenName": "Barbara",
        "honorificSuffix": "III"
    },
    "addresses": [
        {
            "region": "CA",
            "streetAddress": "100 Universal City Plaza",
            "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
            "postalCode": "91608",
            "locality": "Hollywood",
            "country": "USA",
            "type": "work"
        },
        {
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "type": "home"
        }
    ],
    "groups": [
        {
            "value": "3",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/3",
            "type": "direct"
        }
    ],
    "timezone": "America/Los_Angeles",
    "title": "Tour Guide",
    "meta": {
        "lastModified": "2015-01-06T03:24:17.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/145",
        "created": "2015-01-06T03:24:17.000-08:00",
        "resourceType": "User"
    }
}
21.6.1.14 PasswordResetterWithChallenges

この項では、POST操作タイプを使用したPasswordResetterWithChallenges操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.14.1 PasswordResetterWithChallenges Request

PasswordResetterWithChallenges操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordResetterWithChallenges

ヘッダー:

  • Content-Type: application/json

  • Authorization: NA

  • X-Requested-By: <random_value>

本文:

{
  "schemas":
  ["urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordResetterWithChallenges"],
  "userName": "JDOE",
  "challenges":
  [
        {
             "challenge":"What is the name of your pet?",
             "response":"name"
        },
        {
             "challenge":"What is the city of your birth?",
             "response":"city"
        },
        {
             "challenge":"What is your favorite color?",
             "response":"color"
        }
 
   ],
   "password": "Welcome3"
}
21.6.1.14.2 PasswordResetterWithChallengesのレスポンス

PasswordResetterWithChallenges操作のレスポンスは空です。

ステータス: HTTP/1.1 204 No Content

21.6.1.15 PasswordValidator

この項では、POST操作タイプを使用したPasswordValidator操作の例を紹介します。次の項目が含まれます。

21.6.1.15.1 PasswordValidatorのリクエスト

次のリクエストは、潜在的なパスワードを検証します。パスワードの検証リクエストの正常なレスポンスは、パスワードが有効であることを意味します。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordValidator

ヘッダー:

  • Content-Type: application/json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas":
  [
    "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordValidator"
  ],
  "userRef": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
  "password": "jijijSSij1"
}
21.6.1.15.2 PasswordValidatorのレスポンス

PasswordValidator操作のレスポンスの内容は次のとおりです。

ステータス:

  • パスワード・ポリシーに照らしてパスワードの候補が有効である場合: HTTP/1.1 204 No Content

  • パスワード・ポリシーに照らしてパスワードがそのユーザーには無効である場合:

    HTTP/1.1 400 Bad Request
21.6.1.16 UserNameValidator

この項では、POST操作タイプを使用したUserNameValidator操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.16.1 UserNameValidatorのリクエスト

ユーザー名の検証リクエストの正常なレスポンスは、パスワードが有効であることを意味します。次に、リクエストを示します。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/UserNameValidator

ヘッダー:

  • Content-Type: application/json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas":["urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameValidator"],
  "userName": "aUserName"
}
21.6.1.16.2 UserNameValidatorのレスポンス

UserNameValidator操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 204 No Content

21.6.1.17 UserNameGenerator

この項では、POST操作タイプを使用したUserNameGenerator操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.17.1 UserNameGeneratorのリクエスト

UserNameGenerator操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/UserNameGenerator

ヘッダー:

  • Content-Type: application/json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas":["urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameGenerator"],
  "name":
  {
    "formatted": "Ms. Barbara J Doe III",
    "familyName": "Doe",
    "givenName": "Barbara",
    "middleName": "Jane",
    "honorificSuffix": "III"
  }
}
21.6.1.17.2 UserNameGeneratorのレスポンス

UserNameGenerator操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameGenerator"
    ],
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/UserNameGenerator",
        "resourceType": "UserNameGenerator"
    },
    "urn:ietf:params:scim:schemas:core:2.0:User": {
        "userName": "Barbara.Doe@example.com"
    }
}
21.6.1.18 UserNameRecoverer

この項では、POST操作タイプを使用したUserNameRecoverer操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.1.18.1 UserNameRecovererのリクエスト

UserNameRecoverer操作のリクエストは次のとおりです(Authorizationヘッダーなし、認証されていないフロー)。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/UserNameRecoverer

ヘッダー:

  • Content-Type: application/json

  • Authorization: NA

  • X-Requested-By: <random_value>

本文:

{
  "schemas": ["urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:UserNameRecoverer"],
  "email": "myemail@example.com"
}
21.6.1.18.2 UserNameRecovererのレスポンス

UserNameRecoverer操作のレスポンスとして、ユーザー名がユーザーの電子メール・アドレスに送信されます。

ステータス: HTTP/1.1 204 No Content

21.6.2 ロール管理

グループ・リソースに関するSCIMベースAPIの使用例を理解します。

この項では、グループ・リソースの次の例を示します。

21.6.2.1 ロールの表示

この項では、GET操作タイプを使用した「ロールの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.2.1.1 「ロールの表示」のリクエスト

「ロールの表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/Groups?attributes=id,displayName

21.6.2.1.2 「ロールの表示」のレスポンス

「ロールの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 4,
    "Resources": [
        {
            "displayName": "Group1",
            "id": "2"
        },
        {
            "displayName": "SYSTEM ADMINISTRATORS",
            "id": "3"
        },
        {
            "displayName": "Group2",
            "id": "4"
        },
        {
            "displayName": "Group3",
            "id": "5"
        }
    ]
}
21.6.2.2 ロールの作成

この項では、POST操作タイプを使用した「ロールの作成」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.2.2.1 「ロールの作成」のリクエスト

「ロールの作成」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/Groups

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
    "schemas":   
    [       
        "urn:ietf:params:scim:schemas:core:2.0:Group",       
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",       
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group"   
    ],   
    "displayName": "Group33",   
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group":    
    {       
        "email": "group33@example.com",       
        "description": "description1"        
    },   
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group":   
    {       
        "namespace": "Default"   
    }
}
21.6.2.2.2 「ロールの作成」のレスポンス

「ロールの作成」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group",
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group": {
        "organizationsPublishedTo": [
            {
                "value": "3",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
            }
        ],
        "category": {
            "name": "Default",
            "value": 1
        },
        "namespace": "Default",
        "catalog": {
            "tags": "Group33 Group33 Default",
            "requestable": true,
            "certifiable": false,
            "id": "151",
            "categoryName": "Role",
            "auditable": false,
            "itemRisk": 3,
            "hierarchicalDataAvailable": false
        }
    },
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "description": "description1",
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "owner": {
            "lastName": "Administrator",
            "email": "donotreply@example.com",
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "login": "XELSYSADM",
            "firstName": "System",
            "displayName": "NEW_NAME"
        },
        "email": "group33@example.com"
    },
    "meta": {
        "lastModified": "2015-03-11T08:55:57.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/157",
        "created": "2015-03-11T08:55:57.000-07:00",
        "resourceType": "Group"
    },
    "displayName": "Group33",
    "id": "157"
}
21.6.2.3 ロールの変更(PUT)

この項では、PUT操作タイプを使用した「ロールの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.2.3.1 「ロールの変更」(PUT)のリクエスト

「ロールの変更」(PUT)操作のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/157

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group": {
        "organizationsPublishedTo": [
            {
                "value": "3",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
            }
        ],
        "category": {
            "name": "Default",
            "value": 1
        },
        "namespace": "Default"
    },
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group": {
        "description": "description1",
        "localeNames": [
            {
                "name": "Group_group09_53_11.228163",
                "locale": "base"
            }
        ],
 
        "email": "group_new@example.com"
    },
    "displayName": "Group_group09_53_11.228163"
}
21.6.2.3.2 「ロールの変更」(PUT)のレスポンス

「ロールの変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

場所: https://HOST_NAME:PORT/Groups/157

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group": {
        "organizationsPublishedTo": [
            {
                "value": "3",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
            }
        ],
        "category": {
            "name": "Default",
            "value": 1
        },
        "namespace": "Default"
    },
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "description": "description1",
        "localeNames": [
            {
                "name": "Group_group09_53_11.228163",
                "locale": "base"
            }
        ],
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "owner": {
            "lastName": "Administrator",
            "email": "donotreply@example.com",
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "login": "XELSYSADM",
            "displayName": "System Administrator",
            "firstName": "System"
        },
        "email": "group_new@example.com"
    },
    "meta": {
        "lastModified": "2015-01-05T06:59:25.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/157",
        "created": "2015-01-05T06:55:14.000-08:00",
        "resourceType": "Group"
    },
    "displayName": "Group_group09_53_11.228163",
    "id": "157"
}
21.6.2.4 ロールの変更(PATCH)

この項では、PATCH操作タイプを使用した「ロールの変更」操作の例を紹介します。次の項目が含まれます。

21.6.2.4.1 「ロールの変更」(PATCH)のリクエスト

「ロールの変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/153

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace"          ,
      "path":"urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group:description",
      "value":"description3"      
    }   
  ]
}
21.6.2.4.2 「ロールの変更」(PATCH)のレスポンス

「ロールの変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group",
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group": {
        "organizationsPublishedTo": [
            {
                "value": "3",
                "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
            }
        ],
        "category": {
            "name": "Default",
            "value": 1
        },
        "namespace": "Default",
        "catalog": {
            "tags": "replace_catalog_requestable_6587843 replace_catalog_requestable_6587843 Default",
            "requestable": true,
            "certifiable": false,
            "id": "147",
            "categoryName": "Role",
            "auditable": false,
            "itemRisk": 3,
            "hierarchicalDataAvailable": false
        }
    },
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group": {
        "createBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "description": "description3",
        "updateBy": {
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
        },
        "owner": {
            "lastName": "Administrator",
            "email": "donotreply@example.com",
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "login": "XELSYSADM",
            "firstName": "System",
            "displayName": "NEW_NAME"
        }
    },
    "meta": {
        "lastModified": "2015-03-11T08:59:16.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/153",
        "created": "2015-03-11T08:13:11.000-07:00",
        "resourceType": "Group"
    },
    "displayName": "replace_catalog_requestable_6587843",
    "id": "153"
}
21.6.2.5 ロールの削除

この項では、DELETE操作タイプを使用した「ロールの削除」操作の例を紹介します。次の項目が含まれます。

21.6.2.5.1 「ロールの削除」のリクエスト

「ロールの削除」操作のリクエストの内容は次のとおりです。

操作とURI: DELETE http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/153

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

21.6.2.5.2 「ロールの削除」のレスポンス

「ロールの削除」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 204 No Content

21.6.2.6 ロールの削除(PATCH)

この項では、PATCH操作タイプを使用した「ロールの削除」操作の例を紹介します。次の項目が含まれます。

21.6.2.6.1 「ロールの削除」(PATCH)のリクエスト

「ロールの削除」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/<role_id>

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{
  "schemas":
  [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations":
  [
    {
      "op":"remove",
      "path":"urn:ietf:params:scim:schemas:core:2.0:Group:members",
      "value":[
       {
       "value":"<usr_key>",
       "$ref":"http://HOST_NAME:PORT/idaas/im/scim/v1/Users/<usr_key>"
       }
       ]
    }
  ]
 }
21.6.2.6.2 「ロールの削除」(PATCH)のレスポンス

「ロールの削除」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group",
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group",
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OIG:Group": {
        "namespace": "Default",
        "organizationsPublishedTo": [
            {
                "value": "3",
                "$ref":
"http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
            }
        ],
        "category": {
            "name": "Default",
            "value": 1
        },
        "ldapDn": "cn=tesrole1,cn=groups,dc=isc,dc=com",
        "catalog": {
            "auditable": true,
            "hierarchicalDataAvailable": false,
            "id": "101",
            "requestable": true,
            "itemRisk": 3,
            "certifiable": true,
            "categoryName": "Role",
            "tags": "tesrole1 tesrole1 Default"
        }
    },
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:IDM:Group": {
        "createBy": {
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "value": "1"
        },
        "owner": {
            "firstName": "System",
            "lastName": "Administrator",
            "displayName": "System Administrator",
            "login": "XELSYSADM",
            "value": "1",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1",
            "email": "donotreply@oracle.com"
        },
        "updateBy": {
            "value": "5",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/5"
        }
    },
    "members": [
        {
            "value": "7002",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/7002"
        }
    ],
    "meta": {
        "created": "2018-11-13T08:48:49.000+05:30",
        "location":
"http://HOST_NAME:PORT/iam/governance/scim/v1/Groups/<role_id>",
        "lastModified": "2018-11-13T08:53:58.000+05:30",
        "resourceType": "Group"
    },
    "displayName": "<role name>",
    "id": "<role_d>"
}

21.6.3 組織管理

組織リソースに関するSCIMベースAPIの使用例を理解します。

この項では、組織リソースの次の例を示します。

21.6.3.1 組織の表示

この項では、GET操作タイプを使用した「組織の表示」操作の例を紹介します。次の項目が含まれます。

21.6.3.1.1 「組織の表示」のリクエスト

「組織の表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/148

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

21.6.3.1.2 「組織の表示」のレスポンス

「組織の表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

場所: https://HOST_NAME:PORT/Organization/148

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"
    ],
    "parent": {
        "name": "Top",
        "value": "3",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
    },
    "name": "org_pcu3_1426086587854",
    "passwordPolicy": {
        "name": "ppchg_1426086587854",
        "value": "94"
    },
    "id": "148",
    "meta": {
        "lastModified": "2015-03-11T08:16:00.000-07:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/148",
        "created": "2015-03-11T08:16:00.000-07:00",
        "resourceType": "Organization"
    },
    "customerType": "Company",
    "createBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "enforceNewPasswordPolicy": "Yes",
    "updateBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "status": "Active",
    "members": [
        {
            "value": "353",
            "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/353"
        }
    ]
}
21.6.3.2 組織の作成

この項では、POST操作タイプを使用した「組織の作成」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.3.2.1 「組織の作成」のリクエスト

「組織の作成」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{ 
  "schemas":     
  [       
    "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"     
  ],     
  "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization":     
  {       
    "name": "organization16_08_50.141529",       
    "customerType": "Scim1"     
  }
}
21.6.3.2.2 「組織の作成」のレスポンス

「組織の作成」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"
    ],
    "parent": {
        "name": "Top",
        "value": "3",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
    },
    "name": "organization16_08_50.141529",
    "id": "77",
    "meta": {
        "lastModified": "2015-02-06T07:06:46.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77",
        "created": "2015-02-06T07:06:46.000-08:00",
        "resourceType": "Organization"
    },
    "customerType": "Scim1",
    "createBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "enforceNewPasswordPolicy": "Yes",
    "updateBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "status": "Active"
}
21.6.3.3 組織の変更(PUT)

この項では、PUT操作タイプを使用した「組織の変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.3.3.1 「組織の変更」(PUT)のリクエスト

「組織の変更」(PUT)操作のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

 
{ 
  "schemas":     
  [       
    "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"     
  ],     
  "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization":     
  {       
    "name": "organization16_08_53.883452",       
    "customerType": "Scim2"     
  }
}
21.6.3.3.2 「組織の変更」(PUT)のレスポンス

「組織の変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"
    ],
    "parent": {
        "name": "Top",
        "value": "3",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
    },
    "name": "organization16_08_53.883452",
    "id": "77",
    "meta": {
        "lastModified": "2015-02-06T07:09:27.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77",
        "created": "2015-02-06T07:06:46.000-08:00",
        "resourceType": "Organization"
    },
    "customerType": "Scim2",
    "createBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "enforceNewPasswordPolicy": "Yes",
    "updateBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "status": "Active"
}
21.6.3.4 組織の変更(PATCH)

この項では、PATCH操作タイプを使用した「組織の変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.3.4.1 「組織の変更」(PATCH)のリクエスト

「組織の変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace",
      "path":"customerType",
      "value":"Scim3"      
    }   
  ]
}
21.6.3.4.2 「組織の変更」(PATCH)のレスポンス

「組織の変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:Organization"
    ],
    "parent": {
        "name": "Top",
        "value": "3",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/3"
    },
    "name": "organization16_08_53.883452",
    "id": "77",
    "meta": {
        "lastModified": "2015-02-06T07:13:19.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77",
        "created": "2015-02-06T07:06:46.000-08:00",
        "resourceType": "Organization"
    },
    "customerType": "Scim3",
    "createBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "enforceNewPasswordPolicy": "Yes",
    "updateBy": {
        "value": "1",
        "$ref": "http://HOST_NAME:PORT/iam/governance/scim/v1/Users/1"
    },
    "status": "Active"
}
21.6.3.5 組織の削除

この項では、DELETE操作タイプを使用した「組織の削除」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.3.5.1 「組織の削除」のリクエスト

「組織の削除」操作のリクエストの内容は次のとおりです。

操作とURI: DELETE http://HOST_NAME:PORT/iam/governance/scim/v1/Organizations/77

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

21.6.3.5.2 「組織の削除」のレスポンス

「組織の削除」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 204 No Content

21.6.4 パスワード・ポリシー管理

パスワード・ポリシー・リソースに関するSCIMベースAPIの使用例を理解します。

この項では、パスワード・ポリシー・リソースの次の例を示します。

21.6.4.1 パスワード・ポリシーの表示

この項では、GET操作タイプを使用した「パスワード・ポリシーの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.4.1.1 「パスワード・ポリシーの表示」のリクエスト

「パスワード・ポリシーの表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies?filter=(urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy:allowedChars co q)&attributes=id,description,name

21.6.4.1.2 「パスワード・ポリシーの表示」のレスポンス

「パスワード・ポリシーの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 3,
    "Resources": [
        {
            "id": "2",
            "name": "pwp1_1423213466123",
            "description": "1"
        },
        {
            "id": "6",
            "name": "pwp_q_3466186",
            "description": "pwp_q_3466186"
        },
        {
            "id": "36",
            "name": "p1214_1423213645161"
        }
    ]
}
21.6.4.2 パスワード・ポリシーの作成

この項では、POST操作タイプを使用した「パスワード・ポリシーの作成」操作の例を紹介します。内容は次のとおりです。

21.6.4.2.1 「パスワード・ポリシーの作成」のリクエスト

「パスワード・ポリシーの作成」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":    
  [       
    "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy"   
  ],   
  "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy":
  {       
    "name":"pwdpol0901258070",       
    "description":"complex password policy for ST org",       
    "passwordWarningAfterInDays": 20,       
    "passwordExpiresAfterInDays": 30,       
    "minPasswordAgeInDays": 10,       
    "userIdDisallowed": "false",       
    "minLength": 3,       
    "maxLength": 8,       
    "firstNameDisallowed": "true",       
    "challengeSource": 1,       
    "challengeMinQuestions": 3,       
    "challengeMinAnswers": 2,       
    "challengeResponseMinLength": 5,       
    "challengeAllowDuplicateResponses": "false",       
    "challengeMaxIncorrectAttempts": 5,       
    "challengeDefaultQuestions":       
    [           
      {               
        "value": "what is your favorite color"           
      },           
      {               
        "value": "what is name of your pet"           
      },           
      {             
        "value": "which is your favorite movie"           
      },           
      {               
        "value": "which is your favorite sport"           
      }       
    ]   
  }
}
21.6.4.2.2 「パスワード・ポリシーの作成」のレスポンス

「パスワード・ポリシーの作成」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy"
    ],
    "challengesEnabled": false,
    "id": "49",
    "challengeSource": 1,
    "minLength": 3,
    "startsWithAlphabet": false,
    "description": "complex password policy for ST org",
    "name": "pwdpol0901258070",
    "complexPolicy": false,
    "challengeDefaultQuestions": [
        {
            "value": "what is your favorite color"
        },
        {
            "value": "what is name of your pet"
        },
        {
            "value": "which is your favorite movie"
        },
        {
            "value": "which is your favorite sport"
        }
    ],
    "challengeAllAtOnce": true,
    "minPasswordAgeInDays": 10,
    "passwordWarningAfterInDays": 20,
    "challengeResponseMinLength": 5,
    "userIdDisallowed": false,
    "maxLength": 8,
    "challengeMinQuestions": 3,
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49",
        "resourceType": "PasswordPolicy"
    },
    "challengeMaxIncorrectAttempts": 5,
    "challengeMinAnswers": 2,
    "passwordExpiresAfterInDays": 30,
    "challengeAllowDuplicateResponses": false,
    "lastNameDisallowed": false,
    "firstNameDisallowed": true,
    "dictionaryDelimiter": "\u0000"
}
21.6.4.3 パスワード・ポリシーの変更(PUT)

この項では、PUT操作タイプを使用した「パスワード・ポリシーの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.4.3.1 「パスワード・ポリシーの変更」(PUT)のリクエスト

「パスワード・ポリシーの変更」(PUT)操作のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":    
  [       
    "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy"   
  ],   
  "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy":
  {       
    "name":"pwdpol0905770857",       
    "description":"complex password policy for ST org",       
    "passwordWarningAfterInDays": 20,       
    "passwordExpiresAfterInDays": 30,       
    "minPasswordAgeInDays": 10,       
    "userIdDisallowed": "false",       
    "minLength": 3,       
    "maxLength": 8,       
    "firstNameDisallowed": "true",       
    "challengeSource": 1,       
    "challengeMinQuestions": 3,       
    "challengeMinAnswers": 2,       
    "challengeResponseMinLength": 5,       
    "challengeAllowDuplicateResponses": "false",       
    "challengeMaxIncorrectAttempts": 5,       
    "challengeDefaultQuestions":       
    [           
      {               
        "value": "what is your favorite car"           
      },           
      {               
        "value": "what is name of your truck"          
      },          
      {               
        "value": "which is your favorite bicycle"           
      },           
      {               
        "value": "which is your favorite shoe"           
      }       
    ]   
  }
}
21.6.4.3.2 「パスワード・ポリシーの変更」(PUT)のレスポンス

「パスワード・ポリシーの変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy"
    ],
    "challengesEnabled": false,
    "id": "49",
    "challengeSource": 1,
    "minLength": 3,
    "startsWithAlphabet": false,
    "description": "complex password policy for ST org",
    "name": "pwdpol0905770857",
    "complexPolicy": false,
    "challengeDefaultQuestions": [
        {
            "value": "what is your favorite car"
        },
        {
            "value": "what is name of your truck"
        },
        {
            "value": "which is your favorite bicycle"
        },
        {
            "value": "which is your favorite shoe"
        }
    ],
    "challengeAllAtOnce": true,
    "minPasswordAgeInDays": 10,
    "passwordWarningAfterInDays": 20,
    "challengeResponseMinLength": 5,
    "userIdDisallowed": false,
    "maxLength": 8,
    "challengeMinQuestions": 3,
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49",
        "resourceType": "PasswordPolicy"
    },
    "challengeMaxIncorrectAttempts": 5,
    "challengeMinAnswers": 2,
    "passwordExpiresAfterInDays": 30,
    "challengeAllowDuplicateResponses": false,
    "lastNameDisallowed": false,
    "firstNameDisallowed": true,
    "dictionaryDelimiter": "\u0000"
}
21.6.4.4 パスワード・ポリシーの変更(PATCH)

この項では、PATCH操作タイプを使用した「パスワード・ポリシーの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.4.4.1 「パスワード・ポリシーの変更」(PATCH)のリクエスト

「パスワード・ポリシーの変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace",
      "path":"firstNameDisallowed",
      "value":"false"      
    }   
  ]
}
21.6.4.4.2 「パスワード・ポリシーの変更」(PATCH)のレスポンス

「パスワード・ポリシーの変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:IDM:PasswordPolicy"
    ],
    "challengesEnabled": false,
    "id": "49",
    "challengeSource": 1,
    "minLength": 3,
    "startsWithAlphabet": false,
    "description": "complex password policy for ST org",
    "name": "pwdpol0905770857",
    "complexPolicy": false,
    "challengeDefaultQuestions": [
        {
            "value": "what is your favorite car"
        },
        {
            "value": "what is name of your truck"
        },
        {
            "value": "which is your favorite bicycle"
        },
        {
            "value": "which is your favorite shoe"
        }
    ],
    "challengeAllAtOnce": true,
    "minPasswordAgeInDays": 10,
    "passwordWarningAfterInDays": 20,
    "challengeResponseMinLength": 5,
    "userIdDisallowed": false,
    "maxLength": 8,
    "challengeMinQuestions": 3,
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49",
        "resourceType": "PasswordPolicy"
    },
    "challengeMaxIncorrectAttempts": 5,
    "challengeMinAnswers": 2,
    "passwordExpiresAfterInDays": 30,
    "challengeAllowDuplicateResponses": false,
    "lastNameDisallowed": false,
    "firstNameDisallowed": false,
    "dictionaryDelimiter": "\u0000"
}
21.6.4.5 パスワード・ポリシーの削除

この項では、DELETE操作タイプを使用した「パスワード・ポリシーの削除」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.4.5.1 「パスワード・ポリシーの削除」のリクエスト

「パスワード・ポリシーの削除」操作のリクエストの内容は次のとおりです。

操作とURI: DELETE http://HOST_NAME:PORT/iam/governance/scim/v1/PasswordPolicies/49

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

21.6.4.5.2 「パスワード・ポリシーの削除」のレスポンス

「パスワード・ポリシーの削除」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 204 NO Content

21.6.5 通知テンプレート管理

通知テンプレート・リソースに関するSCIMベースAPIの使用例を理解します。

この項では、通知テンプレート・リソースの次の例を示します。

21.6.5.1 通知テンプレートの表示

この項では、GET操作タイプを使用した「通知テンプレートの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.5.1.1 「通知テンプレートの表示」のリクエスト

「通知テンプレートの表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates?attributes=id,name

21.6.5.1.2 「通知テンプレートの表示」のレスポンス

「通知テンプレートの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 4,
    "Resources": [
        {
            "name": "AddProxyNotificationTemplate",
            "id": "12"
        },
        {
            "name": "BulkRequestCreation",
            "id": "6"
        },
        {
            "name": "CreateUserSelfServiceNotification",
            "id": "7"
        },
        {
            "name": "UserDeletedNotificationTemplate",
            "id": "10"
        }
    ]
}
21.6.5.2 通知テンプレートの作成

この項では、POST操作タイプを使用した「通知テンプレートの作成」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.5.2.1 「通知テンプレートの作成」のリクエスト

「通知テンプレートの作成」操作のリクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":       
  [          
    "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate"      
  ],      
  "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate":      
  {          
    "name":"notificationtemplate16_09_14.724166_1",          
    "eventName":"AddProxy",          
    "description":"myTemplate",          
    "locales":           
    [              
      {                  
        "locale": "dddd",                  
        "subject": "Notification for contractors 1",                  
        "encoding": "UTF-8",                  
        "contentType": "text/html, charset=UTF-8",                  
        "shortMessage": "short message1",                  
        "longMessage": "long message1"              
      },              
      {                  
        "locale": "eeee",                  
        "subject": "Notification for contractors 2",                  
        "encoding": "UTF-8",                  
        "contentType": "text/html, charset=UTF-8",                  
        "shortMessage": "short message2",                  
        "longMessage": "long message2"              
      }          
    ]      
  }
}
21.6.5.2.2 「通知テンプレートの作成」のレスポンス

「通知テンプレートの作成」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 201 Created

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate"
    ],
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/25",
        "resourceType": "NotificationTemplate"
    },
    "name": "notificationtemplate16_09_14.724166_1",
    "eventName": "AddProxy",
    "locales": [
        {
            "subject": "Notification for contractors 2",
            "locale": "eeee",
            "shortMessage": "short message2",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message2"
        },
        {
            "subject": "Notification for contractors 1",
            "locale": "dddd",
            "shortMessage": "short message1",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message1"
        }
    ],
    "description": "myTemplate",
    "id": "25"
}
21.6.5.3 通知テンプレートの変更(PUT)

この項では、PUT操作タイプを使用した「通知テンプレートの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.5.3.1 「通知テンプレートの変更」(PUT)のリクエスト

「通知テンプレートの変更」(PUT)操作のリクエストの内容は次のとおりです。

操作とURI: PUT http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/25

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":       
  [          
    "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate"      
  ],      
  "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate":      
  {          
    "name":"notificationtemplate16_09_17.742004_2",          
    "eventName":"AddProxy",          
    "description":"Template to notify contractors after password has been reset",          
    "locales":           
    [              
      {                  
        "subject": "Notification for contractors 1",                  
        "encoding": "UTF-8",                  
        "contentType": "text/html, charset=UTF-8",                  
        "shortMessage": "short message1",                  
        "longMessage": "long message1",                  
        "locale": "ffff"              
      },              
      {                  
        "subject": "Notification for contractors 2",                  
        "encoding": "UTF-8",                  
        "contentType": "text/html, charset=UTF-8",                  
        "shortMessage": "short message2",                  
        "longMessage": "long message2",                  
        "locale": "gggg"              
      }          
    ]      
  }
}
21.6.5.3.2 「通知テンプレートの変更」(PUT)のレスポンス

「通知テンプレートの変更」(PUT)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate"
    ],
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/25",
        "resourceType": "NotificationTemplate"
    },
    "name": "notificationtemplate16_09_14.724166_1",
    "eventName": "AddProxy",
    "locales": [
        {
            "subject": "Notification for contractors 2",
            "locale": "gggg",
            "shortMessage": "short message2",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message2"
        },
        {
            "subject": "Notification for contractors 1",
            "locale": "ffff",
            "shortMessage": "short message1",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message1"
        }
    ],
    "description": "Template to notify contractors after password has been reset",
    "id": "25"
}
21.6.5.4 通知テンプレートの変更(PATCH)

この項では、PATCH操作タイプを使用した「通知テンプレートの変更」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.5.4.1 「通知テンプレートの変更」(PATCH)のリクエスト

「通知テンプレートの変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/25

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace",
      "path":"description",
      "value":"description3"      
    }   
  ]
}
21.6.5.4.2 「通知テンプレートの変更」(PATCH)のレスポンス

「通知テンプレートの変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:NotificationTemplate"
    ],
    "meta": {
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/25",
        "resourceType": "NotificationTemplate"
    },
    "name": "notificationtemplate16_09_14.724166_1",
    "eventName": "AddProxy",
    "locales": [
        {
            "subject": "Notification for contractors 2",
            "locale": "gggg",
            "shortMessage": "short message2",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message2"
        },
        {
            "subject": "Notification for contractors 1",
            "locale": "ffff",
            "shortMessage": "short message1",
            "encoding": "UTF-8",
            "contentType": "text/html, charset=UTF-8",
            "longMessage": "long message1"
        }
    ],
    "description": "description3",
    "id": "25"
}
21.6.5.5 通知テンプレートの削除

この項では、DELETE操作タイプを使用した「通知テンプレートの削除」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.5.5.1 「通知テンプレートの削除」のリクエスト

「通知テンプレートの削除」操作のリクエストの内容は次のとおりです。

操作とURI: DELETE http://HOST_NAME:PORT/iam/governance/scim/v1/NotificationTemplates/12

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

21.6.5.5.2 「通知テンプレートの削除」のレスポンス

「通知テンプレートの削除」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 204 No Content

21.6.6 システム・プロパティ管理

システム・プロパティ・リソースに関するSCIMベースAPIの使用例を理解します。

この項では、システム・プロパティ・リソースの次の例を示します。

21.6.6.1 システム・プロパティの表示

この項では、GET操作タイプを使用した「システム・プロパティの表示」操作のリクエストとレスポンスの例を紹介します。次の項目が含まれます。

21.6.6.1.1 「システム・プロパティの表示」のリクエスト

「システム・プロパティの表示」操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/SystemProperties?filter=(name eq AllowDisabledManagers)

21.6.6.1.2 「システム・プロパティの表示」のレスポンス

「システム・プロパティの表示」操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:SystemProperty"
            ],
            "id": "40",
            "meta": {
                "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/SystemProperties/40",
                "resourceType": "SystemProperty"
            },
            "value": "FALSE",
            "name": "AllowDisabledManagers",
            "displayName": "Is disabled manager allowed"
        }
    ]
}
21.6.6.2 システム・プロパティの変更(PATCH)

この項では、PATCH操作タイプを使用した「システム・プロパティの変更」操作の例を紹介します。次の項目が含まれます。

21.6.6.2.1 「システム・プロパティの変更」(PATCH)のリクエスト

「システム・プロパティの変更」(PATCH)操作のリクエストの内容は次のとおりです。

操作とURI: PATCH http://HOST_NAME:PORT/iam/governance/scim/v1/SystemProperties/27

ヘッダー:

  • Content-Type: application/scim+json

  • 認可: Bearer h480djs93hd8

  • X-Requested-By: <random_value>

本文:

{   
  "schemas":   
  [     
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"   
  ],   
  "Operations":   
  [      
    {         
      "op":"replace",
      "path":"displayName",
      "value":"new_displayName_for_systemProperty"      
    }   
  ]
}
21.6.6.2.2 「システム・プロパティの変更」(PATCH)のレスポンス

「システム・プロパティの変更」(PATCH)操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:core:2.0:OIG:SystemProperty"
    ],
    "id": "27",
    "meta": {
        "lastModified": "2015-02-05T08:44:04.000-08:00",
        "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/SystemProperties/27",
        "created": "2015-02-05T08:44:04.000-08:00",
        "resourceType": "SystemProperty"
    },
    "value": "NONE",
    "name": "OIM.ChallengeQuestionModificationURL",
    "displayName": "new_displayName_for_systemProperty"
}

21.6.7 サービス・プロバイダ構成管理

GET操作タイプを使用したサービス・プロバイダ構成操作のリクエストとレスポンスのSCIMベースAPIの使用例を理解します。

この項の内容は次のとおりです。

21.6.7.1 サービス・プロバイダ構成のリクエスト

サービス・プロバイダ構成操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/ServiceProviderConfigs

21.6.7.2 サービス・プロバイダ構成のレスポンス

サービス・プロバイダ構成操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
            ],
            "patch": {
                "supported": true
            },
            "meta": {
                "location": "http://HOST_NAME:PORT/iam/governance/scim/v1/ServiceProviderConfigs",
                "resourceType": "ServiceProviderConfig"
            },
            "bulk": {
                "maxPayloadSize": 1048576,
                "supported": false,
                "maxOperations": 1000
            },
            "authenticationSchemes": [
                {
                    "documentationUrl": "http://HOST_NAME/help/httpBasic.htm",
                    "specUrl": "http://www.ietf.org/rfc/rfc2617.txt",
                    "description": "Authentication Scheme using the Http Basic Standard",
                    "name": "HTTP Basic"
                }
            ],
            "documentationUrl": "http://HOST_NAME",
            "changePassword": {
                "supported": true
            },
            "etag": {
                "supported": false
            },
            "sort": {
                "supported": true
            },
            "filter": {
                "supported": true,
                "maxResults": 200
            }
        }
    ]
}

21.6.8 リソース・タイプ管理

GET操作タイプを使用したリソース・タイプ管理操作のリクエストとレスポンスの例を理解します。

この項の内容は次のとおりです。

21.6.8.1 リソース・タイプ管理のリクエスト

リソース・タイプ管理操作のリクエストの内容は次のとおりです。

操作とURI: GET http://HOST_NAME:PORT/iam/governance/scim/v1/ResourceTypes?attributes=name

21.6.8.2 リソース・タイプ管理のレスポンス

リソース・タイプ管理操作のレスポンスの内容は次のとおりです。

ステータス: HTTP/1.1 200 OK

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 15,
    "Resources": [
        {
            "name": "User"
        },
        {
            "name": "PasswordValidator"
        },
        {
            "name": "UserNameRecoverer"
        },
        {
            "name": "Schema"
        },
        {
            "name": "ServiceProviderConfig"
        },
        {
            "name": "Organization"
        },
        {
            "name": "Request"
        },
        {
            "name": "Group"
        },
        {
            "name": "PasswordPolicy"
        },
        {
            "name": "SystemProperty"
        },
        {
            "name": "NotificationTemplate"
        },
        {
            "name": "ResourceType"
        },
        {
            "name": "PasswordResetterWithChallenges"
        },
        {
            "name": "UserNameValidator"
        },
        {
            "name": "UserNameGenerator"
        }
    ]
}

21.6.9 POSTを使用した検索

POST操作タイプを使用した検索操作のリクエストとレスポンスの例を理解します。

この項の内容は次のとおりです。

21.6.9.1 POSTを使用した検索のリクエスト

リクエストは、リソース検索の代替方法であるPOST [prefix]/.searchで発行されます。URLでパラメータを渡すかわりに、この項の例に示すように、POST本文でリクエスト・パラメータを渡します。リクエストの内容は次のとおりです。

操作とURI: POST http://HOST_NAME:PORT/iam/governance/scim/v1/Users/.search

Content-Type: application/scim+json

認可: Bearer h480djs93hd8

X-Requested-By: <random_value>

本文:

{
     "schemas":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"],
     "attributes": [ "id", "userName" ],
     "filter": "userType eq \"Employee\" and (emails [type eq \"work\" and value co \"HOST_NAME\"] or name.givenName co \"doe\")",
     "startIndex":1,
     "count":2,
     "sortBy": "userName",
     "sortOrder": "ascending"
}
21.6.9.2 POSTを使用した検索のレスポンス

検索(POST)操作のレスポンスの内容は次のとおりです。

本文:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "itemsPerPage": 2,
    "startIndex": 1,
    "Resources": [
        {
            "id": "10",
            "userName": "John Doe"
        },
        {
            "id": "89",
            "userName": "Mary Doe"
        }
    ]
}

21.6.10 スキーマの取得

GET /Schemasリクエストを使用して、スキーマを取得できます。

Oracle Identity Governance RESTサービスでサポートされるスキーマを取得するには、次のSCIMリクエストを送信します:

GET /Schemas

21.7 SCIMリソースのセキュリティ

SCIMリソースは、カスタムOWSMポリシー、カスタム・リクエスト・ヘッダーおよびCORSホワイトリストを使用して保護されます。

この項の内容は次のとおりです。

21.7.1 OWSMポリシーを使用したSCIMリソースのセキュリティ対策

SCIMリソースは、Oracle Identity Managerのインストールまたはアップグレード時にデフォルトで作成されるカスタムOracle Web Services Governance (OWSM)ポリシーoracle/multi_token_rest_service_policyおよびoracle/no_authentication_service_policyによって保護されます。

これらのポリシーは、トークンがクライアントから送信されたときに次のいずれかの認証ポリシーを強制するか、トークンが指定されていない場合は匿名を許可します。

  • HTTP Basic

  • HTTPヘッダー内のSAML 2.0 Bearerトークン

  • HTTP OAMセキュリティ

  • SPNEGO over HTTPセキュリティ

  • HTTPヘッダー内のJWTトークン

oracle/multi_token_rest_service_policyおよびoracle/no_authentication_service_policyポリシーの詳細は、グローバル・ポリシー・アタッチメントの理解を参照してください。

21.7.2 カスタム・リクエスト・ヘッダーを使用したSCIMリソースのセキュリティ対策

カスタム・リクエスト・ヘッダーを使用して、CSRF攻撃からSCIMリソースを保護できます。

この項の内容は次のとおりです。

21.7.2.1 クロスサイト・リクエスト・フォージェリについて

クロスサイト・リクエスト・フォージェリ(CSRF)は、エンド・ユーザーが現在認証されているWebアプリケーション上で、意図しない操作をユーザーに強制的に実行させる攻撃です。CSRF攻撃は特に、状態を変化させるリクエストを対象とし、偽造されたリクエストに対するレスポンスを確認する手段が攻撃者にはないため、データを盗むことが目的ではありません。電子メールやチャットを通じてリンクを送信するといったソーシャル・エンジニアリングを利用することで、攻撃者は、Webアプリケーションのユーザーに攻撃者が選択した操作を巧みに実行させることが可能です。被害者が通常ユーザーである場合、CSRF攻撃が成功すると、送金や電子メール・アドレスの変更など、状態を変化させるリクエストをユーザーに強制的に実行させることができます。被害者が管理アカウントを持っている場合、CSRF攻撃を受けると、Webアプリケーション全体が危険にさらされる可能性があります。

CSRF攻撃は、悪意のあるリクエストを被害者が送信するよう仕向けます。これにより、被害者の識別情報や権限を継承し、被害者が意図していない機能をかわりに実行します。ほとんどのサイトでは、ユーザーのセッションCookie、IPアドレス、Windowsドメイン資格証明など、サイトに関連するあらゆる資格証明がブラウザ・リクエストに自動的に含まれます。そのため、ユーザーが現在、サイトに対して認証されていれば、サイトでは、被害者から送信された偽造リクエストと被害者から送信された正規のリクエストを区別する手段がありません。

シノニム

CSRF攻撃は、XSRF、シー・サーフ、セッション・ライディング、クロスサイト・リファレンス・フォージェリ、ホスタイル・リンキングなど、他の名称で呼ばれることもあります。

21.7.2.2 アイデンティティRESTサービスへのCSRF保護の適用性

Oracle Identity Governanceに対するHTTPリクエストにはoimjsessionid CookieまたはSSOトークンが自動的に含まれるため、/tokens呼出しにはCSRF保護が必要です。/tokensエンドポイントまたはファサード・トークンWebアプリケーションへのリンクをクリックするよう仕向けられたユーザーが意図せず/tokens呼出しに成功する可能性があるため、一部のシナリオではCSRF保護が必要です。特に、Oracle Identity Governance UIに対して認証を行うシナリオは、HTTP Basic認証シナリオのように、CSRF攻撃に対して脆弱です。トークン・サービスでは、クライアントがCSRFを受けやすいかどうかを見分けることができないため、トークン・サービス、ファサード・トークンWebアプリケーションおよび/tokensサービスへのすべての呼出しをCSRFから保護する必要があります。

Oracle Identity Governanceとの間でHTTPセッションが確立される場合、/tokens実装でリクエスト内のシンクロナイザ・トークンを強制できます。ただし、このメカニズムをHTTP Basic認証で使用することはできません。

かわりに、Oracle Identity GovernanceのSCIMおよびREST APIに対するリクエストが別のオリジンからのものである場合、Originヘッダーを使用してCSRFを強制できます。

CSRF保護を強制するには、Originリクエスト・ヘッダーが必要であり、CORS許可オリジンの計算が使用されます。

21.7.2.3 カスタム・リクエスト・ヘッダーを使用したSCIMリソースの保護

CSRFに対する防御策として、有効なユーザーのみがわかるカスタム・リクエスト・ヘッダーを使用する方法があります。使用するカスタム・ヘッダーは次のとおりです。

X-Requested-By: <Random_value>

このアプローチには、通常はUIを変更する必要がないこととサーバー側の状態を使用しないことの2つの利点があり、CORS保護と組み合せることで堅牢なシステムになります。

このヘッダーは、PUT、POST、PATCH、DELETEなど、システムの状態を変更する可能性があるすべてのHTTPコールに必要です。このようなコールでこのヘッダーが指定されていない場合、SCIMサービスは、特にGET以外のHTTPメソッドについて、 HTTP 400エラー・コードを返します。

21.7.3 オリジン・ホワイトリストを使用したSCIMリソースのセキュリティ対策

オリジン・ホワイトリストを使用して、クロスオリジンHTTPリクエストを制限できます。

この項の内容は次のとおりです。

21.7.3.1 HTTPアクセス制御(CORS)について

あるリソースが、自身が提供されたものとは異なるドメインまたはポートのリソースをリクエストする場合、最初のリソースはクロスオリジンHTTPリクエストを行います。たとえば、http://domain-a.comから提供されたHTMLページがhttp://domain-b.com/image.jpgに対して<img> srcリクエストを行う場合などです。Web上の多くのページは、CSSスタイルシート、イメージ、スクリプトなどのリソースを別のドメインからロードします。

セキュリティ上の理由から、ブラウザでは、スクリプト内から開始されたクロスオリジンHTTPリクエストが制限されます。

Cross-Origin Resource Sharing (CORS)メカニズムにより、Webサーバーのクロスドメイン・アクセス制御が実現し、ドメイン間の安全なデータ転送が可能になります。CORSおよびCORSヘッダーの一般情報は、Mozilla Development NetworkのCORSページを参照してください。

Cross-Origin Resource Sharingの規格は、Webブラウザを使用して情報を読み取ることを許可されたオリジンのセットをサーバーで記述するための新しいHTTPヘッダーを追加することにより機能します。ヘッダーのタイプ、認証、キャッシングなど、HTTPヘッダーの詳細は、Mozilla Development NetworkのHTTP headersページを参照してください。

また、サーバーのデータに副次的影響をもたらす可能性があるHTTPリクエスト・メソッドについては(特に、GET以外のHTTPメソッドや、POSTの使用については)、ブラウザでリクエストをプリフライトし、HTTP OPTIONSリクエスト・メソッドを使用して、サポートされているメソッドをサーバーから収集し、サーバーからの承認に基づいて、実際のHTTPリクエスト・メソッドを使用して実際のリクエストを送信することが仕様で規定されています。HTTP OPTIONSメソッドの構文と例は、Mozilla Development NetworkのOPTIONSページを参照してください。

サーバーでは、CookieやHTTP認証データを含む資格証明をリクエストとともに送信する必要があるかどうかをクライアントに通知することもできます。

21.7.3.2 アイデンティティRESTサービスへのCORSの適用性

Oracle Identity Governanceデプロイメントとは異なるWeb層からHTML5/JSアプリケーションがロードされた場合、Webブラウザの同一オリジン・ポリシーにより、アプリケーションのJSはOracle Identity GovernanceのSCIMおよびRESTリソースにアクセスできません。CORSは、この制限を回避するためのメカニズムです。SCIMおよびJWT用のCORSの実装では、構成可能なAccess-Control-Allow-Origin、具体的には、デプロイメントにあわせて構成可能なホワイトリストがサポートされています。

21.7.3.3 オリジン・ホワイトリストを使用したSCIMサービスの保護

構成可能なホワイトリストは、Oracle Identity GovernanceのXL.AllowedOriginsシステム・プロパティに保持されます。このプロパティで指定したオリジンのみが、SCIMおよびJWTリソースへのアクセスを許可されます。

このホワイトリストには、許可するすべてのオリジンのカンマ区切りリストが含まれている必要があります。MozillaおよびChrome拡張機能は対象外です。

指定するオリジンは、次の形式の有効なURLである必要があります。

<scheme>://<host>.<domain>/<page>

たとえば:

http://myhost.example.com/index.php

XL.AllowedOriginsシステム・プロパティの値を指定する際のガイドラインは、Oracle Identity Governanceの管理のOracle Identity Governanceのデフォルト以外のシステム・プロパティを参照してください。

21.8 Oracle Identity Governance RESTサービス

Identity Governance RESTサービスは、Oracle RESTカタログを通じてアイデンティティ・セルフ・サービス、トークン・サービス、アプリケーション管理およびデプロイメント・マネージャのAPIを提供します。

Oracle Identity Governance RESTサービスでは、Oracle RESTカタログ内の次のAPIがサポートされています。