Authentication
Endpoints for Authentication
ReferenceView as Markdown
Endpoints for Authentication
GET/api/v1/auth/profile
Authentication: Bearer token (JWT)
isCompanybooleancompanyNamestringorganizationNostringroleRole11 fieldsrolenamestringRequired when parent is presentField path: role.nametenantIdnumberRequired when parent is presentField path: role.tenantIdisActivebooleanRequired when parent is presentField path: role.isActiveunauthorized
This response has no body.
curlcurl https://api.subrite.no/api/v1/auth/profile \
--header 'Authorization: Bearer <token>'PATCH/api/v1/auth/profile
Authentication: Bearer token (JWT)
application/jsonfullNamestringOptionalemailstring (email)OptionalmaxLength: 255phonestringOptionaluserRolesarray of UserRoleRequired when parent is presentrolePermissionsarray of RolePermissionRequired when parent is presentField path: role.rolePermissionsNested fields omitted: field limit.tenantTenantRequired when parent is presentField path: role.tenantNested fields omitted: field limit.idnumberRequired when parent is presentField path: role.idcreatedAtstring (date-time)Required when parent is presentField path: role.createdAtupdatedAtstring (date-time)Required when parent is presentField path: role.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: role.deletedAtmetaDataobjectRequired when parent is presentField path: role.metaDatapermissionsarray of SectionPermission4 fieldspermissionssectionIdstringRequired when parent is presentField path: permissions[].sectionIdmaxLength: 255sectionNamestringField path: permissions[].sectionNamemaxLength: 255readPermissionbooleanRequired when parent is presentField path: permissions[].readPermissionupdatePermissionbooleanRequired when parent is presentField path: permissions[].updatePermissionuserSettingsUserSettings11 fieldsuserSettingsnotificationNotificationPreferencesDtoRequired when parent is presentField path: userSettings.notificationidnumberRequired when parent is presentField path: userSettings.idcreatedAtstring (date-time)Required when parent is presentField path: userSettings.createdAtupdatedAtstring (date-time)Required when parent is presentField path: userSettings.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: userSettings.deletedAtreceiveAdminEmailsbooleanRequired when parent is presentField path: userSettings.receiveAdminEmailstwoFactorAuthbooleanRequired when parent is presentField path: userSettings.twoFactorAuthhasSignedDPAbooleanRequired when parent is presentField path: userSettings.hasSignedDPAlanguagestringRequired when parent is presentField path: userSettings.language"en", "no", "sv", "da"metaDataobjectRequired when parent is presentField path: userSettings.metaDatauserUserRequired when parent is presentField path: userSettings.userNested fields omitted: field limit.nicknamestringavatarstringhasActiveSubscriptionbooleanuserTypestringRequired"system_admin", "tenant_admin", "member", "not_set"tenantIdnumberRequiredemailstringRequiredfullNamestringRequiredphonestringRequiredemailVerifiedstringRequiredphoneVerifiedbooleanRequiredisOwnerbooleanRequiredisTestUserbooleanRequiredimagestringRequiredcreatedInCheckoutUuidstringRequireduserRolesarray of UserRole9 fieldsuserRolesuserIdnumberRequired when parent is presentField path: userRoles[].userIdroleIdnumberRequired when parent is presentField path: userRoles[].roleIduserUserRequired when parent is presentField path: userRoles[].userNested fields omitted: field limit.roleRoleRequired when parent is presentField path: userRoles[].roleNested fields omitted: field limit.idnumberRequired when parent is presentField path: userRoles[].idcreatedAtstring (date-time)Required when parent is presentField path: userRoles[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: userRoles[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: userRoles[].deletedAtmetaDataobjectRequired when parent is presentField path: userRoles[].metaDatanotesarray of NoteRequired12 fieldsnotesnotestringRequired when parent is presentField path: notes[].notememberIdstringRequired when parent is presentField path: notes[].memberIdadminUserIdnumberRequired when parent is presentField path: notes[].adminUserIdmemberMemberRequired when parent is presentField path: notes[].memberNested fields omitted: field limit.adminUserUserRequired when parent is presentField path: notes[].adminUserNested fields omitted: field limit.tenantIdnumberRequired when parent is presentField path: notes[].tenantIdtenantTenantRequired when parent is presentField path: notes[].tenantNested fields omitted: field limit.idnumberRequired when parent is presentField path: notes[].idcreatedAtstring (date-time)Required when parent is presentField path: notes[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: notes[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: notes[].deletedAtmetaDataobjectRequired when parent is presentField path: notes[].metaDataexportHistoryarray of ExportHistoryRequiredNested fields omitted: field limit.memberMemberNested fields omitted: field limit.tenantTenantRequiredNested fields omitted: field limit.userAccountsarray of UserAccountRequiredNested fields omitted: field limit.userSessionsarray of UserSessionRequiredNested fields omitted: field limit.idnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequired{
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"role": {
"name": "string",
"tenantId": 0,
"isActive": true,
"userRoles": [],
"rolePermissions": [],
"tenant": {
"additionalFeatures": [],
"disabledFeatures": [],
"taxRates": [],
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"permissions": [
{}
],
"userSettings": {
"notification": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"receiveAdminEmails": true,
"twoFactorAuth": true,
"hasSignedDPA": true,
"language": "en",
"metaData": {},
"user": {
"userRoles": [],
"notes": [],
"exportHistory": [],
"userAccounts": [],
"userSessions": [],
"metaData": {}
}
},
"nickname": "string",
"avatar": "string",
"hasActiveSubscription": true,
"userType": "system_admin",
"tenantId": 0,
"email": "string",
"fullName": "<fullName>",
"phone": "<phone>",
"emailVerified": "string",
"phoneVerified": true,
"isOwner": true,
"isTestUser": true,
"image": "string",
"createdInCheckoutUuid": "string",
"userRoles": [
{
"metaData": {}
}
],
"notes": [
{
"metaData": {}
}
],
"exportHistory": [
{
"metaData": {}
}
],
"member": {
"userId": 0,
"memberNumber": 0,
"tenantId": 0,
"externalId": "string",
"fullName": "<fullName>",
"nickName": "string",
"avatar": "string",
"email": "string",
"birthDate": "<birthDate>",
"phone": "<phone>",
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"deleteAfterExpiration": true,
"customPropertyValues": {},
"productRecipients": [],
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"userAccounts": [
{}
],
"userSessions": [
{}
],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}maxLength: 20userSettingsUserSettingsDtoOptional2 conditional requirements in nested objects5 fieldsuserSettingsreceiveAdminEmailsbooleanOptionalField path: userSettings.receiveAdminEmailstwoFactorAuthbooleanOptionalField path: userSettings.twoFactorAuthhasSignedDPAbooleanOptionalField path: userSettings.hasSignedDPAlanguagestringOptionalField path: userSettings.language"en", "no", "sv", "da"notificationNotificationPreferencesDtoOptionalField path: userSettings.notification2 required when the containing object is present2 fieldsuserSettings.notificationproductUpdatesbooleanRequired when parent is presentField path: userSettings.notification.productUpdatesincidentAlertsbooleanRequired when parent is presentField path: userSettings.notification.incidentAlerts{
"fullName": "<fullName>",
"email": "user@example.com",
"phone": "<phone>",
"userSettings": {
"receiveAdminEmails": true,
"twoFactorAuth": true,
"hasSignedDPA": true,
"language": "en"
}
}Same fields as Get logged in user details with role and permissions. (200).
{
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"role": {
"name": "string",
"tenantId": 0,
"isActive": true,
"userRoles": [],
"rolePermissions": [],
"tenant": {
"additionalFeatures": [],
"disabledFeatures": [],
"taxRates": [],
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"permissions": [
{}
],
"userSettings": {
"notification": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"receiveAdminEmails": true,
"twoFactorAuth": true,
"hasSignedDPA": true,
"language": "en",
"metaData": {},
"user": {
"userRoles": [],
"notes": [],
"exportHistory": [],
"userAccounts": [],
"userSessions": [],
"metaData": {}
}
},
"nickname": "string",
"avatar": "string",
"hasActiveSubscription": true,
"userType": "system_admin",
"tenantId": 0,
"email": "string",
"fullName": "<fullName>",
"phone": "<phone>",
"emailVerified": "string",
"phoneVerified": true,
"isOwner": true,
"isTestUser": true,
"image": "string",
"createdInCheckoutUuid": "string",
"userRoles": [
{
"metaData": {}
}
],
"notes": [
{
"metaData": {}
}
],
"exportHistory": [
{
"metaData": {}
}
],
"member": {
"userId": 0,
"memberNumber": 0,
"tenantId": 0,
"externalId": "string",
"fullName": "<fullName>",
"nickName": "string",
"avatar": "string",
"email": "string",
"birthDate": "<birthDate>",
"phone": "<phone>",
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"deleteAfterExpiration": true,
"customPropertyValues": {},
"productRecipients": [],
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"userAccounts": [
{}
],
"userSessions": [
{}
],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}Unauthorized
This response has no body.
curlcurl https://api.subrite.no/api/v1/auth/profile \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"fullName": "<fullName>",
"email": "user@example.com",
"phone": "<phone>",
"userSettings": {
"receiveAdminEmails": true,
"twoFactorAuth": true,
"hasSignedDPA": true,
"language": "en",
"notification": {}
}
}'