Jump to

• Request
• Response

Create User Group

post

http://{host}:{port}/veridata/v1/services/admin/usergroups

Required Role: Administrator, SuperUser, CommandLineOperator

Create User Group

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accessIds: array accessIds
  Array of access ids to be mapped to User Group.
• description: string
• name(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "accessIds":{
            "type":"array",
            "description":"Array of access ids to be mapped to User Group.",
            "items":{
                "type":"integer",
                "description":"access Ids.",
                "format":"int64"
            }
        }
    },
    "example":{
        "name":"AdminGroup",
        "description":"admin",
        "accessIds":[
            0
        ]
    },
    "required":[
        "name"
    ]
}

Example:

{
    "name":"AdminGroup",
    "description":"admin",
    "accessIds":[
        0
    ]
}

Nested Schema : accessIds

Type: array

Array of access ids to be mapped to User Group.

Show Source

• Array of: integer(int64)
  access Ids.

{
    "type":"array",
    "description":"Array of access ids to be mapped to User Group.",
    "items":{
        "type":"integer",
        "description":"access Ids.",
        "format":"int64"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

User Group created successfully

Body ()

Root Schema : UserGroupPostResponse

Type: object

Show Source

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

  Example: 2024-02-03T10:15:30Z
• description: string
• id: integer
• isModifiable: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isModifiable":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    },
    "example":{
        "id":1001,
        "name":"UserGroup1",
        "description":"group1",
        "isModifiable":"true",
        "createdOn":"2024-02-03T10:15:30Z"
    }
}

Example:

{
    "id":1001,
    "name":"UserGroup1",
    "description":"group1",
    "isModifiable":"true",
    "createdOn":"2024-02-03T10:15:30Z"
}

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