Jump to

• Request
• Response

Retrieve User

get

http://{host}:{port}/veridata/v1/services/admin/users/{Id}

Required Role: Administrator, CommandLineOperator

Retrieve User

Request

Path Parameters

• Id(required): integer(int64)
  user ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieved User details successfully.

Body ()

Root Schema : UserDetails

Type: object

Show Source

• createdOn: string (date-time)
  Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

  Example: 2024-02-03T10:15:30Z
• description: string
• emailId: string
• groups: array groups
• id: integer (int64)
  user ID.
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"user ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "emailId":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListUserGroup"
            }
        }
    },
    "example":{
        "id":0,
        "name":"User1",
        "emailId":"[e-mail]",
        "createdOn":"2024-02-03T10:15:30Z",
        "description":"user1",
        "groups":[
            {
                "id":1001,
                "name":"Admin",
                "isModifiable":"true"
            }
        ]
    }
}

Example:

{
    "id":0,
    "name":"User1",
    "emailId":"[e-mail]",
    "createdOn":"2024-02-03T10:15:30Z",
    "description":"user1",
    "groups":[
        {
            "id":1001,
            "name":"Admin",
            "isModifiable":"true"
        }
    ]
}

Nested Schema : groups

Type: array

Show Source

• Array of: object ListUserGroup

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

Nested Schema : ListUserGroup

Type: object

Show Source

• id: integer
• isModifiable: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "isModifiable":{
            "type":"string"
        }
    }
}

400 Response

Bad Request.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top