API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

users

Creates a users resource.

Creates a users resource.

Authorizations:
JWT
path Parameters
id
required
string

users identifier

Request Body schema:
required

The new users resource

person
string <iri-reference>
Array of objects (AccessToken.jsonld)
keyValue
Array of strings <iri-reference> [ items <iri-reference > ]
systemSalt
string
username
string
usernameCanonical
string
email
string
emailCanonical
string
salt
string

The salt to use for hashing.

password
string

Encrypted password. Must be persisted.

plainPassword
string

Plain password. Used for model validation. Must not be persisted.

lastLogin
string or null <date-time>
confirmationToken
string or null

Random string sent to the user email address in order to verify it.

passwordRequestedAt
string or null <date-time>
notes
string or null
roles
Array of strings <iri-reference> [ items <iri-reference > ]
defaultCorporation
string or null <iri-reference>
landingPageUrl
string or null
preloadedRolesArray
Array of strings

Property that can be set with the preloaded array of roles and used to load roles from instead of loading collection.

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
emailAuthCodeEnabled
boolean

Property that should be set on the user to enabled or disable email auth code for 2FA/MFA authenticaton.

role
boolean
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "person": "https://example.com/",
  • "accessTokens": [],
  • "keyValue": [],
  • "systemSalt": "string",
  • "username": "string",
  • "usernameCanonical": "string",
  • "email": "string",
  • "emailCanonical": "string",
  • "salt": "string",
  • "password": "string",
  • "plainPassword": "string",
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "confirmationToken": "string",
  • "passwordRequestedAt": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "roles": [],
  • "defaultCorporation": "https://example.com/",
  • "landingPageUrl": "string",
  • "preloadedRolesArray": [
    ],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "emailAuthCodeEnabled": true,
  • "accessToken": {},
  • "role": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "person": {
    },
  • "defaultCorporation": {
    },
  • "landingPageUrl": "string",
  • "shortcode": "UU",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "keyValueListing": "string",
  • "rolesListing": "string",
  • "toString": "string",
  • "userUniqueId": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}