Oracle Enterprise ManagerのREST API

ユーザーの削除

delete

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users/{userId}

このAPIは、既存のユーザーを削除するリクエストを送信し、ユーザーの削除は非同期に実行されます。ユーザーが削除されると、そのユーザーが作成したジョブはすべて停止および削除されます。また、そのユーザーが作成したブラックアウトも削除されます。ただし、ユーザー削除のコールを発行したときに、そのユーザーが作成したブラックアウトがアクティブな場合は、そのユーザーを削除できません。この状態は、ユーザー削除の無効状態とみなされます。まず、そうしたアクティブなブラックアウトをすべて停止してから、失敗したユーザー削除コールを再発行する必要があります。

リクエスト

パス・パラメータ

userId(必須): string

ユーザーのID。

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

application/json

ルート・スキーマ: schema

型: object

ユーザー削除の情報

ソースの表示

delegateUserName: string

削除されるユーザーが所有するセキュア・オブジェクトを割り当てるユーザーの名前。delegateUserNameを指定しないと、削除されるユーザーが所有するセキュア・オブジェクトは削除されます。

例: USER_B
forceDelete: boolean

ユーザーのログイン・セッションがアクティブな場合でもユーザーの削除を強制実行するフラグ。デフォルト値はfalse

例: true

{
    "type":"object",
    "properties":{
        "delegateUserName":{
            "type":"string",
            "description":"Name of User to assign the secure objects owned by User who is getting deleted. If delegateUserName is not specified then the secure objects owned by the user getting deleted, will be deleted.",
            "example":"USER_B"
        },
        "forceDelete":{
            "type":"boolean",
            "description":"Flag to force the deletion of User though User has active logged-in sessions. Default value is false.",
            "example":true
        }
    },
    "description":"Information for User deletion"
}

先頭に戻る

レスポンス

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

application/json

202レスポンス

ユーザーを削除するリクエストが承認されました

ヘッダー

Location:

「ユーザーの削除」アクションのステータスを取得するURL。

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

404レスポンス

見つかりません

ルート・スキーマ: 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"
        }
    }
}

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

先頭に戻る