Jump to

• Request
• Response

List users

get

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

The API returns a list of users for a given filtering criteria. Returns the first page of results ordered by name (ascending) by default.

Request

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 2000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. The api will return no more than the number specified as limit, but might not return that exact number.

  Default Value: 20
• name: string
  Exact name of User to be filtered. It is case insensitive filtering.

  Example:

  CloudAdmin

• nameContains: string
  Part of User Name used to filter Users. It is case insensitive filtering.

  Example:

  Admin

• page: string
  System generated page token of a page.
• sort: string
  The order of the result set with direction. Allowed sort field is name. Allowed directions are DESC and ASC

  Example:

  name:DESC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of Users returned successfully

Body ()

Root Schema : UserCollection

Type: object

This is the representation of list of Users.

Show Source

• count(required): integer
  The number of Users in this page

  Example: 20
• items(required): array items
  The list of users
• links(required): object links
  Read Only: true

  The result set navigation links

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

Nested Schema : items

Type: array

The list of users

Show Source

• Array of: object UserSummary
  This is the representation of a User.

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

Nested Schema : links

Type: object

Read Only: true

The result set navigation links

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self: object Link
  Represents a link(could be self, previous or 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
}

Nested Schema : UserSummary

Type: object

This is the representation of a User.

Match All

Show Source

• object allOf UserDetails
  This is the representation of a User.

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

Nested Schema : UserDetails

Type: object

This is the representation of a User.

Show Source

• category: string
  User category like Administrator / Super Administrator / Repository Owner

  Example: Super Administrator
• externalId: string
  External User Name of the User as mentioned in Identity Provider (like LDAP)

  Example: CLOUD_MANAGER
• id: string
  Unique identifier for a User

  Example: B0FBBE587FD201E2E0537013790A7D03
• isLocked: boolean
  Flag that says whether the User is locked or not

  Example: false
• lifecycleStatus: string
  User is Active status or BeingDeleted status

  Example: Active
• links: object links
  the User related links
• name: string
  Name for a User

  Example: 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"
        }
    ]
}

Match All

Show Source

• object UserCommonDetails
  It represents some information of a User

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

Nested Schema : UserCommonDetails

Type: object

It represents some information of a User

Show Source

• authenticationType: array authenticationType
  Authentication Type of the User
• contact: string
  Minimum Length: 0

  Maximum Length: 128

  Contact Number of a User

  Example: 21212221212
• costCenter: string
  Minimum Length: 0

  Maximum Length: 1024

  Cost Center of a User

  Example: TestCostCenter
• department: string
  Minimum Length: 0

  Maximum Length: 1024

  Department of a User

  Example: HumanResource
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Description about a User

  Example: This user is a Test User
• emails: string
  Minimum Length: 0

  Maximum Length: 128

  Email ids of a User with comma as a separator. Each email can have max length of 128 letters.

  Example: [e-mail],[e-mail]
• isPasswordChangeAllowed: boolean
  Flag to say whether User is allowed to change his/her own password

  Example: true
• lineOfBusiness: string
  Minimum Length: 0

  Maximum Length: 1024

  Line-Of-Business of a User

  Example: TestBusiness
• location: string
  Minimum Length: 0

  Maximum Length: 1024

  Location of a User

  Example: Bangalore
• passwordProfile: string
  Name of Password Profile

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

Nested Schema : authenticationType

Type: array

Authentication Type of the User

Show Source

• Array of: string
  Allowed Values: [ "Repository", "SSO", "Enterprise" ]

  This is the representation of Authentication type of User.

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

Example:

Repository

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /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 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  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

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

Match All

Show Source

• object ErrorResponse
  Error response

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

Nested Schema : missingPrivileges

Type: array

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

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

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

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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"
        }
    }
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: 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 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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"
        }
    }
}

Default Response

Unexpected Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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"
        }
    }
}

Back to Top