Jump to

• Request
• Response
• Examples

Get users by user name

get

/userManagement/v1/user

Get users by user name

Request

Query Parameters

• filter: string
  only filter based on userName is supported

  Example:

  filter=userName eq "bjensen"

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/json;charset=utf-8

200 Response

Success response from target IDM

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CompactUserDataObject
  UserName and ID fields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompactUserDataObject"
    }
}

Nested Schema : CompactUserDataObject

Type: object

UserName and ID fields

Show Source

• id: string
• userName: string

{
    "description":"UserName and ID fields",
    "type":"object",
    "properties":{
        "userName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

400 Response

Unsupported Query Param OR Request.

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to get all users by submitting a GET request on the REST resource using cURL.

Note:

Only the /?filter=userName eq "userNameToBeSearched" filter is supported by GET operation.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X GET https://{FABRIC_HOST}/userManagement/v1/user?filter=userName eq "bjensen" -H "Content-Type: application/json" | json_pp

Example of Response Body

The following shows the contents of the response body in JSON format.

[
  {
    "id": "User_ID1",
    "userName": "[e-mail]"
  }
]

Back to Top