Users

Used for identification.

Add a user.

HTTP Responses codes for "Add a user."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
POST /api/v1/user/add

Response

  • canCreateOrganisations boolean
  • createdAt date-time
  • email string
  • identity uuid
  • oidcId uuid
  • username string
                
{
  "properties": {
    "canCreateOrganisations": {
      "type": "boolean"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "oidcId": {
      "format": "uuid",
      "type": "string"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}

Search users by username.

Query Parameters:

  • username
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "Search users by username."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
UserSearchResult
  • email string
  • username string
GET /api/v1/users/search

Response

  • content array
    List of #/components/schemas/UserSearchResult
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/UserSearchResult"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "items": {
        "$ref": "#/components/schemas/SortObject"
      },
      "type": "array"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
← Update Channels
Observability →