/profile

Last updated 11 days ago

Search Profiles

Searches all users in the system and returning the metadata for all matches against the given search filter. Optionally provide before and after params to specify a time range [after, before] for last-logged-in profiles matching in that range (inclusive). If before is not specified (or a negative number is provided) but after is valid, the query will return all records successive to the given after timestamp. Similarly, if after is not specified (or a negative number is provided) but before is valid, the query will return all records preceding the given before timestamp. Note that search and time range parameters currently cannot be combined in the same query.

get

/profile

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

beforeany

afterany

applicationany

userany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/profile' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a Profile

Supplying the create profile request, this will update the profile with the new information supplied in the body of the request. This will fire an event, dev.getelements.elements.service.profile.created, from the event manifest.

post

/profile

Authorizations

Body

userIdanyrequired

The user id this profile belongs to.

applicationIdanyrequired

The application id this profile belongs to.

imageUrlany

A URL to the image of the profile. (ie the User's Avatar).

displayNameany

A non-unique display name for this profile.

metadataany

A map of arbitrary metadata.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/profile' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "applicationId": null,
    "imageUrl": null,
    "displayName": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Profile

Supplying an update request will attempt to update the profile. The call will return the profile as it was written to the database.

put

/profile/{profileId}

Authorizations

Path parameters

profileIdanyrequired

Body

imageUrlany

A URL to the image of the profile. (ie the User's Avatar).

displayNameany

A non-unique display name for this profile.

metadataany

A map of arbitrary metadata.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/profile/{profileId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "imageUrl": null,
    "displayName": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Profile

Deletes and permanently removes the Profile from the server. The server maykeep some record around to preserve relationships and references, but this profile will not be accessible again until it is recreated.

delete

/profile/{profileId}

Authorizations

Path parameters

profileIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/profile/{profileId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets the current Profile

This is a special endpoing which fetches the current Profile based on current auth credentials. This considers the currently loggged-in Dser as well as the Application or Application Configuration against which the User is operating. This may not be availble, in which case the appopraite error is rasied.

get

/profile/current

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/profile/current' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Specific Profile

Gets a specific profile by profile ID.

get

/profile/{name}

Authorizations

Path parameters

nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/profile/{name}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Profile image object

put

/profile/{profileId}/image

Authorizations

Path parameters

profileIdanyrequired

Body

mimeTypeanyrequired

MimeType of image

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/profile/{profileId}/image' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "mimeType": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}