Jump to

• Request
• Response

Retrieve User Access

get

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

Required Role: Administrator

Retrieve User Access

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieved access Successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Access

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Access"
    },
    "example":[
        {
            "id":0,
            "name":"Admin",
            "description":"Admin",
            "createdAt":"2025-04-04T12:06:09.569Z",
            "modifiedAt":"2025-04-04T12:06:09.569Z"
        }
    ]
}

Example:

[
    {
        "id":0,
        "name":"Admin",
        "description":"Admin",
        "createdAt":"2025-04-04T12:06:09.569Z",
        "modifiedAt":"2025-04-04T12:06:09.569Z"
    }
]

Nested Schema : Access

Type: object

Show Source

• createdAt: string (date-time)
• description: string
• id: integer (int64)
  user group ID.
• modifiedAt: string (date-time)
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time"
        },
        "modifiedAt":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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