Jump to

• Request
• Response

Replace User

put

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

Required Role: Administrator, CommandLineOperator

Replace User

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• groupIds: array groupIds
  Array of group ID to be mapped to user.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateUserBasicDetails"
        }
    ],
    "properties":{
        "groupIds":{
            "type":"array",
            "description":"Array of group ID to be mapped to user.",
            "items":{
                "type":"integer",
                "description":"group Ids.",
                "format":"int64"
            }
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"user",
        "groupIds":[
            0
        ]
    }
}

Match All

Show Source

• object schema

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateUserBasicDetails"
        }
    ],
    "properties":{
        "groupIds":{
            "type":"array",
            "description":"Array of group ID to be mapped to user.",
            "items":{
                "type":"integer",
                "description":"group Ids.",
                "format":"int64"
            }
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"user",
        "groupIds":[
            0
        ]
    }
}

Example:

{
    "emailId":"[e-mail]",
    "description":"user",
    "groupIds":[
        0
    ]
}

Nested Schema : groupIds

Type: array

Array of group ID to be mapped to user.

Show Source

• Array of: integer(int64)
  group Ids.

{
    "type":"array",
    "description":"Array of group ID to be mapped to user.",
    "items":{
        "type":"integer",
        "description":"group Ids.",
        "format":"int64"
    }
}

Nested Schema : schema

Type: object

Show Source

• description: string
• emailId: string

{
    "type":"object",
    "properties":{
        "emailId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"current user"
    }
}

Example:

{
    "emailId":"[e-mail]",
    "description":"current user"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

User updated successfully.

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