移動先

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

新規ユーザーを作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users

このAPIは新しいユーザーを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

新しいユーザーを作成するための入力

ソースの表示

• expirePasswordNow: boolean
  次回のユーザー・ログイン時に新しいパスワードを要求するために、今すぐユーザー・パスワードを期限切れにするかどうかを示すフラグ

  例: true
• externalId: string
  最小長: 0

  最大長: 256

  LDAPなどのアイデンティティ・プロバイダに記載されているユーザーの外部ユーザー名

  例: CLOUD_ADMIN
• name(必須): string
  最小長: 1

  最大長: 256

  新しいユーザーの名前

  例: CLOUD_ADMIN
• password(必須): string (password)
  ユーザーのパスワード

  例: userPasscode123$
• privilegeGrants: array privilegeGrants
  ユーザーに付与する権限のリスト
• roleGrants: array roleGrants
  ユーザーに付与するロールのリスト

{
    "required":[
        "name",
        "password"
    ],
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"256",
            "minLength":"1",
            "type":"string",
            "description":"Name of the new User",
            "example":"CLOUD_ADMIN"
        },
        "password":{
            "type":"string",
            "description":"Password for the User",
            "format":"password",
            "example":"userPasscode123$"
        },
        "externalId":{
            "maxLength":"256",
            "minLength":"0",
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider like LDAP",
            "example":"CLOUD_ADMIN"
        },
        "expirePasswordNow":{
            "type":"boolean",
            "description":"Flag to say whether User password should expire now, so that new password will be requested when the User login next time",
            "example":true
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privilege to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        }
    },
    "description":"Input for creating a new User",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

すべてに一致

新しいユーザーを作成するための入力

ソースの表示

• object UserCommonDetails
  ユーザーの一部の情報を表します

{
    "required":[
        "name",
        "password"
    ],
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"256",
            "minLength":"1",
            "type":"string",
            "description":"Name of the new User",
            "example":"CLOUD_ADMIN"
        },
        "password":{
            "type":"string",
            "description":"Password for the User",
            "format":"password",
            "example":"userPasscode123$"
        },
        "externalId":{
            "maxLength":"256",
            "minLength":"0",
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider like LDAP",
            "example":"CLOUD_ADMIN"
        },
        "expirePasswordNow":{
            "type":"boolean",
            "description":"Flag to say whether User password should expire now, so that new password will be requested when the User login next time",
            "example":true
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privilege to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        }
    },
    "description":"Input for creating a new User",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

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

型: array

ユーザーに付与する権限のリスト

ソースの表示

• 配列: object PrivilegeGrantDetails
  ユーザーまたはロールを作成/変更するための権限付与の詳細

{
    "type":"array",
    "description":"List of Privilege to be given to the User",
    "items":{
        "$ref":"#/components/schemas/PrivilegeGrantDetails"
    }
}

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

型: array

ユーザーに付与するロールのリスト

ソースの表示

• 配列: object RoleGrantSummary
  ユーザーまたは別のロールに付与されたロールに関する情報

{
    "type":"array",
    "description":"List of Roles to be granted to the User",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

型: object

ユーザーの一部の情報を表します

ソースの表示

• authenticationType: array authenticationType
  ユーザーの認証タイプ
• contact: string
  最小長: 0

  最大長: 128

  ユーザーの連絡先番号

  例: 21212221212
• costCenter: string
  最小長: 0

  最大長: 1024

  ユーザーのコスト・センター

  例: TestCostCenter
• department: string
  最小長: 0

  最大長: 1024

  ユーザーの部門

  例: HumanResource
• description: string
  最小長: 0

  最大長: 4000

  ユーザーに関する説明

  例: This user is a Test User
• emails: string
  最小長: 0

  最大長: 128

  セパレータとしてカンマを使用したユーザーの電子メールID。各電子メールの最大長は128文字です。

  例: [e-mail],[e-mail]
• isPasswordChangeAllowed: boolean
  ユーザーが自分の所有するパスワードの変更を許可されているかどうかを示すフラグ

  例: true
• lineOfBusiness: string
  最小長: 0

  最大長: 1024

  ユーザーのライン・オブ・ビジネス

  例: TestBusiness
• location: string
  最小長: 0

  最大長: 1024

  ユーザーの場所

  例: Bangalore
• passwordProfile: string
  パスワード・プロファイルの名前

  例: MGMT_ADMIN_USER_PROFILE

{
    "type":"object",
    "properties":{
        "authenticationType":{
            "type":"array",
            "description":"Authentication Type of the User",
            "example":"Repository",
            "items":{
                "$ref":"#/components/schemas/AuthenticationType"
            }
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Description about a User",
            "example":"This user is a Test User"
        },
        "emails":{
            "maxLength":"128",
            "minLength":"0",
            "type":"string",
            "description":"Email ids of a User with comma as a separator. Each email can have max length of 128 letters.",
            "example":"[e-mail],[e-mail]"
        },
        "costCenter":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Cost Center of a User",
            "example":"TestCostCenter"
        },
        "department":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Department of a User",
            "example":"HumanResource"
        },
        "lineOfBusiness":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Line-Of-Business of a User",
            "example":"TestBusiness"
        },
        "location":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Location of a User",
            "example":"Bangalore"
        },
        "contact":{
            "maxLength":"128",
            "minLength":"0",
            "type":"string",
            "description":"Contact Number of a User",
            "example":"21212221212"
        },
        "isPasswordChangeAllowed":{
            "type":"boolean",
            "description":"Flag to say whether User is allowed to change his/her own password",
            "example":true
        },
        "passwordProfile":{
            "type":"string",
            "description":"Name of Password Profile",
            "example":"MGMT_ADMIN_USER_PROFILE"
        }
    },
    "description":"It represents some information of a User"
}

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

型: object

ユーザーまたはロールを作成/変更するための権限付与の詳細

ソースの表示

• name: string
  権限名

  例: VIEW_TARGET
• secureResources: array secureResources
  権限が適用されるSecureResourcesのリスト

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"VIEW_TARGET"
        },
        "secureResources":{
            "type":"array",
            "description":"List of SecureResources on which the Privilege is applicable",
            "items":{
                "$ref":"#/components/schemas/SecureResourceDetails"
            }
        }
    },
    "description":"Privilege Grant details for createing/modifying a User or a Role"
}

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

型: array

権限が適用されるSecureResourcesのリスト

ソースの表示

• 配列: object SecureResourceDetails
  ユーザーまたはロールを作成/変更するためのセキュア・リソースの詳細を表します。

{
    "type":"array",
    "description":"List of SecureResources on which the Privilege is applicable",
    "items":{
        "$ref":"#/components/schemas/SecureResourceDetails"
    }
}

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

型: object

ユーザーまたはロールを作成/変更するためのセキュア・リソースの詳細を表します。

ソースの表示

• id: string
  リソースのID

  例: DE5CD14CE9D0C0EBEFFFDDEBAA83DA33
• propagationPolicy: array propagationPolicy
  権限が適用されるスコープ。これは、TARGETと呼ばれるセキュア・リソース・タイプにのみ適用されます。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the Resource",
            "example":"DE5CD14CE9D0C0EBEFFFDDEBAA83DA33"
        },
        "propagationPolicy":{
            "type":"array",
            "description":"Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.",
            "example":"MEMBERS",
            "items":{
                "$ref":"#/components/schemas/PropagationPolicy"
            }
        }
    },
    "description":"It represents Secure Resource details for creating/modifying a User or a Role."
}

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

型: array

権限が適用されるスコープ。これは、TARGETと呼ばれるセキュア・リソース・タイプにのみ適用されます。

ソースの表示

• 配列: string
  指定可能な値: [ "ALL", "SELF", "MEMBERS" ]

  これにより、コンポジット・リソースのどの部分に権限が適用されるかを示すタイプが得られます。- ALLは、コンポジット・リソースとそのメンバーに権限が付与されることを意味します。- SELFは、コンポジット・リソースにのみ権限が付与されることを意味します。- MEMBERSは、コンポジット・リソースのメンバーにのみ権限が付与されることを意味します。

{
    "type":"array",
    "description":"Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.",
    "example":"MEMBERS",
    "items":{
        "$ref":"#/components/schemas/PropagationPolicy"
    }
}

例:

MEMBERS

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

型: object

ユーザーまたは別のロールに付与されたロールに関する情報

ソースの表示

• description: string
  読取り専用: true

  ロールについての説明

  例: This Role is an Test Role
• id: string
  読取り専用: true

  ロール付与の一意識別子

  例: B0F9D83F6E313B03E0537013790ACA39
• isPrivate: boolean
  読取り専用: true

  ロールの付与がプライベート・ロールかどうかを示すフラグ。

  例: true
• isWithAdmin: boolean
  読取り専用: true

  プライベート・ロールがWITH_ADMINとして付与されているかどうかを示すフラグ。これは、ロールがプライベート・ロールの場合に表示されます

  例: true
• links: object links
  読取り専用: true

  ロールの関連リンク
• name: string
  ロール名

  例: EM_ALL_ADMINISTRATOR
• owner: string
  読取り専用: true

  ロールの所有者/作成者

  例: SYSMAN
• type: string
  読取り専用: true

  ロールのタイプ(EMロール、Oracle定義ロール、外部ロールなど)

  例: Oracle Defined Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role Grant",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"string",
            "description":"Type of Role like EM Role, Oracle Defined Role, External Role",
            "readOnly":true,
            "example":"Oracle Defined Role"
        },
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "readOnly":true,
            "example":"This Role is an Test Role"
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Flag says whether grant Role is a private role or not.",
            "readOnly":true,
            "example":true
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role",
            "readOnly":true,
            "example":true
        },
        "owner":{
            "type":"string",
            "description":"Owner / Creator of the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "roleLink":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Role related links",
            "readOnly":true
        }
    },
    "description":"Info about Role granted to a User or to an another Role"
}

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

型: object

読取り専用: true

ロールの関連リンク

ソースの表示

• roleLink: object Link
  REST APIを参照するリンク。

{
    "type":"object",
    "properties":{
        "roleLink":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Role related links",
    "readOnly":true
}

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

型: object

REST APIを参照するリンク。

ソースの表示

• href: string
  リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

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

型: array

ユーザーの認証タイプ

ソースの表示

• 配列: string
  指定可能な値: [ "Repository", "SSO", "Enterprise" ]

  これはユーザーの認証タイプを表すものです。

{
    "type":"array",
    "description":"Authentication Type of the User",
    "example":"Repository",
    "items":{
        "$ref":"#/components/schemas/AuthenticationType"
    }
}

例:

Repository

先頭に戻る

レスポンス

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

• application/json

201レスポンス

ユーザーが正常に作成されました

ヘッダー

• Location:
  作成されたユーザーを取得するURL。

本文()

ルート・スキーマ: User

型: object

これはユーザーを表すものです。

ソースの表示

• privilegeGrants: array privilegeGrants
  ユーザーに付与する権限のリスト
• roleGrants: array roleGrants
  ユーザーに付与するロールのリスト

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserDetails"
        }
    ]
}

すべてに一致

これはユーザーを表すものです。

ソースの表示

• object allOf UserDetails
  これはユーザーを表すものです。

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserDetails"
        }
    ]
}

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

型: array

ユーザーに付与する権限のリスト

ソースの表示

• 配列: object PrivilegeGrantSummary
  ユーザーまたはロールへの権限付与

{
    "type":"array",
    "description":"List of Privileges to be given to the User",
    "items":{
        "$ref":"#/components/schemas/PrivilegeGrantSummary"
    }
}

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

型: array

ユーザーに付与するロールのリスト

ソースの表示

• 配列: object RoleGrantSummary
  ユーザーまたは別のロールに付与されたロールに関する情報

{
    "type":"array",
    "description":"List of Roles to be granted to the User",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

型: object

これはユーザーを表すものです。

ソースの表示

• category: string
  管理者/スーパー管理者/リポジトリ所有者などのユーザー・カテゴリ

  例: Super Administrator
• externalId: string
  アイデンティティ・プロバイダ(LDAPなど)に記載されているユーザーの外部ユーザー名

  例: CLOUD_MANAGER
• id: string
  ユーザーの一意識別子

  例: B0FBBE587FD201E2E0537013790A7D03
• isLocked: boolean
  ユーザーがロックされているかどうかを示すフラグ

  例: false
• lifecycleStatus: string
  ユーザーはActiveステータスまたはBeingDeletedステータスです

  例: Active
• links: object links
  ユーザーの関連リンク
• name: string
  ユーザーの名前

  例: CLOUD_MANAGER

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a User",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name for a User",
            "example":"CLOUD_MANAGER"
        },
        "category":{
            "type":"string",
            "description":"User category like Administrator / Super Administrator / Repository Owner",
            "example":"Super Administrator"
        },
        "externalId":{
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider (like LDAP)",
            "example":"CLOUD_MANAGER"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"User is Active status or BeingDeleted status",
            "example":"Active"
        },
        "isLocked":{
            "type":"boolean",
            "description":"Flag that says whether the User is locked or not",
            "example":false
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the User related links"
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

すべてに一致

これはユーザーを表すものです。

ソースの表示

• object UserCommonDetails
  ユーザーの一部の情報を表します

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a User",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name for a User",
            "example":"CLOUD_MANAGER"
        },
        "category":{
            "type":"string",
            "description":"User category like Administrator / Super Administrator / Repository Owner",
            "example":"Super Administrator"
        },
        "externalId":{
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider (like LDAP)",
            "example":"CLOUD_MANAGER"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"User is Active status or BeingDeleted status",
            "example":"Active"
        },
        "isLocked":{
            "type":"boolean",
            "description":"Flag that says whether the User is locked or not",
            "example":false
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the User related links"
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

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

型: object

ユーザーの一部の情報を表します

ソースの表示

• authenticationType: array authenticationType
  ユーザーの認証タイプ
• contact: string
  最小長: 0

  最大長: 128

  ユーザーの連絡先番号

  例: 21212221212
• costCenter: string
  最小長: 0

  最大長: 1024

  ユーザーのコスト・センター

  例: TestCostCenter
• department: string
  最小長: 0

  最大長: 1024

  ユーザーの部門

  例: HumanResource
• description: string
  最小長: 0

  最大長: 4000

  ユーザーに関する説明

  例: This user is a Test User
• emails: string
  最小長: 0

  最大長: 128

  セパレータとしてカンマを使用したユーザーの電子メールID。各電子メールの最大長は128文字です。

  例: [e-mail],[e-mail]
• isPasswordChangeAllowed: boolean
  ユーザーが自分の所有するパスワードの変更を許可されているかどうかを示すフラグ

  例: true
• lineOfBusiness: string
  最小長: 0

  最大長: 1024

  ユーザーのライン・オブ・ビジネス

  例: TestBusiness
• location: string
  最小長: 0

  最大長: 1024

  ユーザーの場所

  例: Bangalore
• passwordProfile: string
  パスワード・プロファイルの名前

  例: MGMT_ADMIN_USER_PROFILE

{
    "type":"object",
    "properties":{
        "authenticationType":{
            "type":"array",
            "description":"Authentication Type of the User",
            "example":"Repository",
            "items":{
                "$ref":"#/components/schemas/AuthenticationType"
            }
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Description about a User",
            "example":"This user is a Test User"
        },
        "emails":{
            "maxLength":"128",
            "minLength":"0",
            "type":"string",
            "description":"Email ids of a User with comma as a separator. Each email can have max length of 128 letters.",
            "example":"[e-mail],[e-mail]"
        },
        "costCenter":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Cost Center of a User",
            "example":"TestCostCenter"
        },
        "department":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Department of a User",
            "example":"HumanResource"
        },
        "lineOfBusiness":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Line-Of-Business of a User",
            "example":"TestBusiness"
        },
        "location":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string",
            "description":"Location of a User",
            "example":"Bangalore"
        },
        "contact":{
            "maxLength":"128",
            "minLength":"0",
            "type":"string",
            "description":"Contact Number of a User",
            "example":"21212221212"
        },
        "isPasswordChangeAllowed":{
            "type":"boolean",
            "description":"Flag to say whether User is allowed to change his/her own password",
            "example":true
        },
        "passwordProfile":{
            "type":"string",
            "description":"Name of Password Profile",
            "example":"MGMT_ADMIN_USER_PROFILE"
        }
    },
    "description":"It represents some information of a User"
}

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

型: object

ユーザーまたはロールへの権限付与

ソースの表示

• description: string
  読取り専用: true

  権限についての説明

  例: Ability to view Jobs
• displayName: string
  読取り専用: true

  権限の表示名

  例: View Report
• links: object links
  権限付与に関連するリンク
• name: string
  権限名

  例: VIEW_TARGET
• scope: array scope
  読取り専用: true

  権限のスコープ
• secureResourceType: string
  読取り専用: true

  権限のSecureResourceタイプ

  例: JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"VIEW_TARGET"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the Privilege",
            "readOnly":true,
            "example":"View Report"
        },
        "description":{
            "type":"string",
            "description":"Description about the Privilege",
            "readOnly":true,
            "example":"Ability to view Jobs"
        },
        "secureResourceType":{
            "type":"string",
            "description":"SecureResource Type of the Privilege",
            "readOnly":true,
            "example":"JOB"
        },
        "scope":{
            "type":"array",
            "description":"Scope of the Privilege",
            "readOnly":true,
            "example":"INSTANCE",
            "items":{
                "$ref":"#/components/schemas/PrivilegeScopes"
            }
        },
        "links":{
            "type":"object",
            "properties":{
                "privilege":{
                    "$ref":"#/components/schemas/Link"
                },
                "secureResources":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"links related to the privilege grant"
        }
    },
    "description":"Privilege Grant to a User or to a Role"
}

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

型: object

権限付与に関連するリンク

ソースの表示

• privilege: object Link
  REST APIを参照するリンク。
• secureResources: object Link
  REST APIを参照するリンク。

{
    "type":"object",
    "properties":{
        "privilege":{
            "$ref":"#/components/schemas/Link"
        },
        "secureResources":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"links related to the privilege grant"
}

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

型: array

読取り専用: true

権限のスコープ

ソースの表示

• 配列: string
  指定可能な値: [ "INSTANCE", "CLASS", "SYSTEM", "SET" ]

  これは権限のスコープを表すものです。

{
    "type":"array",
    "description":"Scope of the Privilege",
    "readOnly":true,
    "example":"INSTANCE",
    "items":{
        "$ref":"#/components/schemas/PrivilegeScopes"
    }
}

例:

INSTANCE

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

型: object

REST APIを参照するリンク。

ソースの表示

• href: string
  リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

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

型: object

ユーザーまたは別のロールに付与されたロールに関する情報

ソースの表示

• description: string
  読取り専用: true

  ロールについての説明

  例: This Role is an Test Role
• id: string
  読取り専用: true

  ロール付与の一意識別子

  例: B0F9D83F6E313B03E0537013790ACA39
• isPrivate: boolean
  読取り専用: true

  ロールの付与がプライベート・ロールかどうかを示すフラグ。

  例: true
• isWithAdmin: boolean
  読取り専用: true

  プライベート・ロールがWITH_ADMINとして付与されているかどうかを示すフラグ。これは、ロールがプライベート・ロールの場合に表示されます

  例: true
• links: object links
  読取り専用: true

  ロールの関連リンク
• name: string
  ロール名

  例: EM_ALL_ADMINISTRATOR
• owner: string
  読取り専用: true

  ロールの所有者/作成者

  例: SYSMAN
• type: string
  読取り専用: true

  ロールのタイプ(EMロール、Oracle定義ロール、外部ロールなど)

  例: Oracle Defined Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role Grant",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"string",
            "description":"Type of Role like EM Role, Oracle Defined Role, External Role",
            "readOnly":true,
            "example":"Oracle Defined Role"
        },
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "readOnly":true,
            "example":"This Role is an Test Role"
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Flag says whether grant Role is a private role or not.",
            "readOnly":true,
            "example":true
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role",
            "readOnly":true,
            "example":true
        },
        "owner":{
            "type":"string",
            "description":"Owner / Creator of the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "roleLink":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Role related links",
            "readOnly":true
        }
    },
    "description":"Info about Role granted to a User or to an another Role"
}

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

型: object

読取り専用: true

ロールの関連リンク

ソースの表示

• roleLink: object Link
  REST APIを参照するリンク。

{
    "type":"object",
    "properties":{
        "roleLink":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Role related links",
    "readOnly":true
}

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

型: array

ユーザーの認証タイプ

ソースの表示

• 配列: string
  指定可能な値: [ "Repository", "SSO", "Enterprise" ]

  これはユーザーの認証タイプを表すものです。

{
    "type":"array",
    "description":"Authentication Type of the User",
    "example":"Repository",
    "items":{
        "$ref":"#/components/schemas/AuthenticationType"
    }
}

例:

Repository

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

認証に失敗しました

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403レスポンス

許可されていません

本文()

ルート・スキーマ: MissingPrivErrorResponse

型: object

必要な権限がない場合にエラーとして返送されるレスポンス

ソースの表示

• missingPrivileges: array missingPrivileges
  エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

すべてに一致

必要な権限がない場合にエラーとして返送されるレスポンス

ソースの表示

• object ErrorResponse
  エラー発生時に返送されるレスポンス

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

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

型: array

エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます

ソースの表示

• 配列: object MissingPrivilegeSummary
  これは、リソースの表示または管理のための権限がないことを表します。

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

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

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

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

型: object

これは、リソースの表示または管理のための権限がないことを表します。

ソースの表示

• displayName: string
  権限の表示名

  例: Manage
• name: string
  権限の名前

  例: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

409レスポンス

重複したリソース

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

サービスを使用できません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る