移動先

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

指定の検索詳細に対するユーザーのリスト

post

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

このAPIは、リクエスト本文で指定された検索詳細に対するユーザーのリストを返します。このAPIは、デフォルトでは名前順(昇順)で結果を返します。検索は、ユーザーIDのリストを指定するか、権限基準(システム権限またはセキュア・リソースIDを持つオブジェクト権限による)を指定することで実行できます。

リクエスト

問合せパラメータ

• limit: integer
  最小値: 1

  最大値: 2000

  リストのページ分割用。ページ当たりの最大結果数、またはページ分割される"List"コールで返すアイテムの最大数。このAPIでは、limitとして指定した数より多を返すことはありませんが、その数が必ずしも返されるというわけではありません。

  デフォルト値: 20
• page: string
  ページのシステム生成ページ・トークン。
• sort: string
  方向付きの結果セットの順序。許容されるソート・フィールドは名前です。指定可能な方向はDESCとASCです

  例:

  name:DESC

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

• application/json

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

ルート・スキーマ: schema

型: object

ユーザーの検索条件を指定するオブジェクト

ソースの表示

• privilegeCriteria: object UserSearchPrivilegeCriteria
  権限およびセキュア・リソースIDに基づいてユーザー検索基準を指定するためのオブジェクト
• userIds: array userIds
  ユーザーIDのリスト

{
    "type":"object",
    "properties":{
        "userIds":{
            "type":"array",
            "description":"list of User Ids",
            "example":[
                "B0F9D83F6E313B03E0537013790ACA12",
                "B129D83F6E313CD3E0589013790ACA39"
            ],
            "items":{
                "type":"string"
            }
        },
        "privilegeCriteria":{
            "$ref":"#/components/schemas/UserSearchPrivilegeCriteria"
        }
    },
    "description":"Object for providing searching conditions for Users"
}

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

型: object

権限およびセキュア・リソースIDに基づいてユーザー検索基準を指定するためのオブジェクト

ソースの表示

• includeSuperAdmins: boolean
  ユーザーにスーパー管理者を含めるかどうかのフィルタ

  例: false
• privilegeName: string
  権限名

  例: EDITT_JOB
• secureResourceId: string
  セキュア・リソースのID

  例: 7A9DC0E23DFE8DFDE050590AC0EC2AD8

{
    "type":"object",
    "properties":{
        "privilegeName":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"EDITT_JOB"
        },
        "secureResourceId":{
            "type":"string",
            "description":"Id of a Secure Resource",
            "example":"7A9DC0E23DFE8DFDE050590AC0EC2AD8"
        },
        "includeSuperAdmins":{
            "type":"boolean",
            "description":"filter users include super admin or not",
            "example":false
        }
    },
    "description":"Object for providing User search criteria based on a Privilege and a Secure Resource Id"
}

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

型: array

ユーザーIDのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of User Ids",
    "example":[
        "B0F9D83F6E313B03E0537013790ACA12",
        "B129D83F6E313CD3E0589013790ACA39"
    ],
    "items":{
        "type":"string"
    }
}

例:

[
    "B0F9D83F6E313B03E0537013790ACA12",
    "B129D83F6E313CD3E0589013790ACA39"
]

例

例の選択 searchByUserIds searchByPrivilege searchByPrivilegeAndResourceId

先頭に戻る

レスポンス

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

• application/json

200レスポンス

検索に対するユーザーのリストが正常に返されました

本文()

ルート・スキーマ: UserCollection

型: object

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

ソースの表示

• count(必須): integer
  このページ内のユーザー数

  例: 20
• items(必須): array items
  ユーザーのリスト
• links(必須): object links
  読取り専用: true

  結果セットのナビゲーション・リンク

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of Users in this page",
            "example":"20"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The result set navigation links",
            "readOnly":true
        },
        "items":{
            "type":"array",
            "description":"The list of users",
            "items":{
                "$ref":"#/components/schemas/UserSummary"
            }
        }
    },
    "description":"This is the representation of list of Users."
}

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

型: array

ユーザーのリスト

ソースの表示

• 配列: object UserSummary
  これはユーザーを表すものです。

{
    "type":"array",
    "description":"The list of users",
    "items":{
        "$ref":"#/components/schemas/UserSummary"
    }
}

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

型: object

読取り専用: true

結果セットのナビゲーション・リンク

ソースの表示

• next: object Link
  リンクを表します(self、previous、nextのいずれか)
• previous: object Link
  リンクを表します(self、previous、nextのいずれか)
• self: object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The result set navigation links",
    "readOnly":true
}

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

型: object

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

すべてに一致

ソースの表示

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

{
    "type":"object",
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserDetails"
        }
    ]
}

ネストされたスキーマ: 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"
}

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

型: array

ユーザーの認証タイプ

ソースの表示

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

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

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

例:

Repository

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

• href: string
  リンクのためのURL

  例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

認証に失敗しました

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

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
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

ネストされたスキーマ: 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."
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る