Profile Registration
After your app is set up and has jwtTokenForPermissionRequestsAndProfiles correctly saved, it can proceed to create a new profile.
Before proceeding, please read about profiles here in introduction
When to create a new profile?
Now it's time to ask yourself a question about whether your app is about to produce its own unique data or not.
If not, you can skip creating a profile and go to Permissions part.
Profile registration
You are here because your app has been developed to produce its own data. Before it can start saving that data in this system, it first needs to tell this system something about the structure of that data.
As you can see, the profile registration request object is very similar to the event itself. That's because the auth service stores these profiles as general events in the Data Storage system.
As you already know, each Event needs to have profile field set in the metadata so that the system knows of what type this event is.
Therefore, this new permission request needs to have metadata.profile set to core:profile-registration_v1.
metadata.profile really needs to be set to core:profile-registration_v1! Nothing else won't work. core:profile-registration_v1 is automatically registered in the system and is added to the Data Storage component via a manual running of a script when this whole system is being set up.
If you are the future admin of this system, head over to auth service setup to know which script needs to be run when the whole system is being set up for the first time. If you are a developer of a new app, ignore this.
This is the content of core:profile-registration_v1:
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"createdDate": { "type": "string", "format": "date-time" },
"profile": { "type": "string" },
"source": { "type": "string" },
"acceptedDate": { "type": "string", "format": "date-time" }
},
"required": [
"createdDate",
"profile",
"source",
"acceptedDate"
]
},
"payload": {
"type": "object",
"properties": {
"profile_name": { "type": "string" },
"json_schema": { "type": "object" }
},
"required": ["profile_name", "json_schema"]
}
},
"required": ["metadata", "payload"]
}
To create a new profile, a request to /app/api/registerNewProfile (POST) endpoint needs to be made.
This is what the body of the request needs to look like:
{
"jwtTokenForPermissionRequestsAndProfiles": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjY1ZmFlMDk0N2E5MGI0YTUyNjNhNDk4MCIsIm5hbWVEZWZpbmVkQnlVc2VyIjoiTXkgTmV3IEFwcGxpY2F0aW9uIiwibmFtZURlZmluZWRCeUFwcCI6ImFwcGxpY2F0aW9uLmNvbSIsImlhdCI6MTcxMDk0MDcxMywiZXhwIjoxMTE3ODIyMDcxM30.3zHTC0_igQKfzjF8uZadJLkmd4qRXY_hePd_M6pmPj0",
"metadata": {
"createdDate": "2024-02-08T21:56:18.277Z",
"profile": "core:profile-registration_v1"
},
"payload": {
"profile_name": "application.com/first_profile",
"json_schema": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
],
"additionalProperties": false
}
}
}
There are multiple kinds of resposnes based on the outcome:
- request is successfull - profile created
{
"message": "Profile registered successfully"
}
- profile with a given name already exists but the content of json schema is the same (hash is computed internally and matched against existing profile)
{
"message": "Profile registered successfully",
"code": "ALREADY_EXISING_WITH_SAME_SCHEMA"
}
As you can see, additional code has been returned but this can be ignored.
- profile with a given name already exists and json schemas differ from each other (this cannot be resolved and manual intervention is needed)
{
"jwtTokenForPermissionRequestsAndProfiles": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjY1ZmFlMDk0N2E5MGI0YTUyNjNhNDk4MCIsIm5hbWVEZWZpbmVkQnlVc2VyIjoiTXkgTmV3IEFwcGxpY2F0aW9uIiwibmFtZURlZmluZWRCeUFwcCI6ImFwcGxpY2F0aW9uLmNvbSIsImlhdCI6MTcxMDk0MDcxMywiZXhwIjoxMTE3ODIyMDcxM30.3zHTC0_igQKfzjF8uZadJLkmd4qRXY_hePd_M6pmPj0",
"metadata": {
"createdDate": "2024-02-08T21:56:18.277Z",
"profile": "core:profile-registration_v1"
},
"payload": {
"profile_name": "application.com/first_profile",
"json_schema": {
"type": "object",
"properties": {
"differentKey": {
"type": "object"
}
},
"required": [
"differentKey"
],
"additionalProperties": false
}
}
}
{
"message": "Profile name must be unique"
}
- something missing in the request
For instance this request lacks jwt token:
{
"metadata": {
"createdDate": "2024-02-08T21:56:18.277Z",
"profile": "core:profile-registration_v1"
},
"payload": {
"profile_name": "application.com/first_profile",
"json_schema": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
],
"additionalProperties": false
}
}
}
{
"message": "Missing required fields"
}
- invalid jwt token
{
"message": "Invalid or expired JWT token"
}
You might suppose your app now has all permissions to this profile since it just created it a few moments ago but that is not the case!
Next step for your app is to request permissions for that profile as if it was a profile created by another app.
Congratulations! Your app has now its own profile registered in the system! 🎉🎉🎉