0% found this document useful (0 votes)
20 views

OPenPath

The document provides API examples for user authentication and organization user management on the OpenPath platform. It includes sample input and output JSON structures for logging in and creating a user, detailing user attributes, organization details, and access tokens. The data includes information about user features, package plans, and scopes of access within the organization.

Uploaded by

mak.ronaldo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
20 views

OPenPath

The document provides API examples for user authentication and organization user management on the OpenPath platform. It includes sample input and output JSON structures for logging in and creating a user, detailing user attributes, organization details, and access tokens. The data includes information about user features, package plans, and scopes of access within the organization.

Uploaded by

mak.ronaldo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 11

 https://api.openpath.

com/auth/login
Input:
{

"email": "[email protected]",

"password": "Bnf#68@*9KsV"

Output:
{

"data": {

"expiresAt": "2021-09-21T11:45:57.000Z",

"createdAt": "2021-09-07T11:45:57.000Z",

"identityId": 2213047,

"identity": {

"id": 2213047,

"namespace": {

"id": 7687,

"nickname": "org:1core-solution-sandbox"

},

"tokenScopeList": [

"org": {

"id": 5930,

"name": "1Core Solution Sandbox",

"opal": "opal:prod:helium:alpha:5930:org:5930",

"parentOrg": null,

"packagePlans": [

"id": 34,

"package": {

"id": 10,
"name": "Basic",

"packageFeatures": [

"config": {

"count": 500

},

"id": 74,

"feature": {

"id": 1,

"name": "Users Included",

"code": "users"

},

"config": {

"count": 1000000

},

"id": 75,

"feature": {

"id": 2,

"name": "Administrators",

"code": "administrators"

},

"config": null,

"id": 76,

"feature": {

"id": 3,

"name": "Remote Unlock",

"code": "remoteUnlock"
}

},

"config": {

"count": 1000000

},

"id": 77,

"feature": {

"id": 4,

"name": "Guest Pass",

"code": "guestPass"

},

"config": null,

"id": 78,

"feature": {

"id": 5,

"name": "Schedules",

"code": "schedules"

},

"config": null,

"id": 81,

"feature": {

"id": 10,

"name": "Wiegand Relay",

"code": "wiegandRelay"

},
{

"config": null,

"id": 82,

"feature": {

"id": 12,

"name": "Web Hooks",

"code": "webHooks"

},

"config": null,

"id": 83,

"feature": {

"id": 14,

"name": "Custom Entry States",

"code": "customEntryStates"

},

"config": null,

"id": 85,

"feature": {

"id": 18,

"name": "Lifetime Warranty",

"code": "lifetimeWarranty"

},

"config": null,

"id": 87,

"feature": {
"id": 20,

"name": "Unlimited Entries",

"code": "entries"

},

"config": null,

"id": 226,

"feature": {

"id": 30,

"name": "Basic Rules Engine",

"code": "basicRulesEngine"

},

"config": null,

"id": 221,

"feature": {

"id": 53,

"name": "Basic Tech Support",

"code": "basicTechSupport"

},

"isSelected": true

},

"id": 50,

"package": {

"id": 14,
"name": "Additional Users Over 500",

"packageFeatures": [

"config": null,

"id": 147,

"feature": {

"id": 1,

"name": "Users Included",

"code": "users"

},

"isSelected": true

},

"id": 54,

"package": {

"id": 15,

"name": "Elevator I/O Boards",

"packageFeatures": [

"config": null,

"id": 175,

"feature": {

"id": 21,

"name": "Elevator I/O Boards",

"code": "elevatorIoBoards"

]
},

"isSelected": true

},

"id": 58,

"package": {

"id": 16,

"name": "Lockdown",

"packageFeatures": [

"config": null,

"id": 176,

"feature": {

"id": 7,

"name": "Lockdown Plans",

"code": "lockdown"

},

"isSelected": true

},

"user": {

"id": 2367785,

"opal": "opal:prod:helium:alpha:5930:user:2367785"

},

"scope": [

"o5930-admin:r",

"o5930-admin:w",
"o5930-configurations:r",

"o5930-configurations:w",

"o5930-dash:r",

"o5930-dash:w",

"o5930-hw:r",

"o5930-hw:w",

"o5930-integrations:r",

"o5930-integrations:w",

"o5930-ldp:r",

"o5930-ldp:w",

"o5930-opvideoDevice:r",

"o5930-opvideoDevice:w",

"o5930-role:r",

"o5930-role:w",

"o5930-rpt:r",

"o5930-rpt:w",

"o5930-site:r",

"o5930-site:w",

"o5930-user2367785:r",

"o5930-user2367785:w",

"o5930-user:r",

"o5930-user:w",

"o5930-videoProviderLive:w",

"o5930-videoProviderPlayback:w"

},

"org": {

"id": null,

"name": null

},
"user": {

"id": null,

"opal": null

},

"scope": [

"i2213047:r",

"i2213047:w"

],

"token":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eUlkIjoyMjEzMDQ3LCJybmQiOjAuNDY3OTQz
NDc4OTQ5NjMzOTUsImlhdCI6MTYzMTAxNTE1NywiZXhwIjoxNjMyMjI0NzU3fQ.-tbIISg-
cjGTBLKsdPMd0gQfyVz-ttP7sAn5x847iBM"

},

"meta": {

"accessToken": null

 https://api.openpath.com/orgs/5930/users
Input:
{

"identity": {

"email": "[email protected]",

"password": "subtest123",

"firstName": "maria",

"lastName": "sharapova"

Output:
{

"data": {
"opal": "opal:prod:helium:alpha:5930:user:2537059",

"id": 2537059,

"status": "A",

"startDate": null,

"endDate": null,

"hasRemoteUnlock": true,

"isOverrideAllowed": false,

"externalId": null,

"manuallyInactivatedAt": null,

"lastActivityAt": null,

"createdAt": "2021-09-07T12:17:08.000Z",

"identity": {

"fullName": "maria sharapova",

"initials": "ms",

"opal": "opal:prod:helium:alpha::identity:2381985",

"id": 2381985,

"firstName": "maria",

"middleName": null,

"lastName": "sharapova",

"email": "[email protected]",

"isEmailVerified": false,

"idpUniqueIdentifier": "",

"createdAt": "2021-09-07T12:17:08.000Z",

"updatedAt": "2021-09-07T12:17:08.000Z",

"namespace": {

"id": 7687,

"nickname": "org:1core-solution-sandbox",

"namespaceType": {

"id": 2,

"name": "Local Org",

"modelName": "org"
},

"org": {

"id": 5930,

"name": "1Core Solution Sandbox"

},

"needsPasswordChange": false

},

"meta": {

"accessToken": {

"scopeUpdatedAt": "2021-08-25T05:13:11.000Z"

},

"siteSpecificAccess": null

--------------------------------------------------------------------------------------------------------------------------------------

You might also like