@@ -12,7 +12,7 @@ nextjs:
1212
1313## new AccessControl()
1414
15- AccessControl is a driver to work with the TerminusDB and TerminusCMS access control API.
15+ AccessControl is a driver to work with the TerminusDB and DFRNT TerminusDB cloud access control API once launched .
1616
1717For credentials, you can use a JWT token, an API token or basic authentication with username and password.
1818
@@ -94,7 +94,7 @@ The jwt api token to use
9494
9595##### accessControl.setApiToken(atokenpi)
9696
97- Sets the API token for the object. Create a TerminusCMS account to [ get your API token] ( /docs/how-to-connect-terminuscms/ ) .
97+ Sets the API token for the object. Create a DFRNT TerminusDB cloud account to [ get your API token] ( /docs/how-to-connect-terminuscms/ ) .
9898
9999Param
100100
@@ -106,7 +106,7 @@ atokenpi
106106
107107` string `
108108
109- The API token to use to connect with TerminusCMS
109+ The API token to use to connect with DFRNT TerminusDB cloud
110110
111111## setApiKey
112112
@@ -124,7 +124,7 @@ atokenpi
124124
125125` string `
126126
127- The API token to use to connect with TerminusCMS
127+ The API token to use to connect with TerminusDB
128128
129129## getAPIUrl
130130
@@ -447,15 +447,15 @@ client.manageCapability(myUser,myteam/db__001,[writer],"grant","database").then(
447447
448448##### accessControl.getAccessRoles() ⇒ ` Promise `
449449
450- \- -TerminusCMS and TerminusDB API --- Get all the system database roles types.
450+ \- -TerminusDB and TerminusDB API --- Get all the system database roles types.
451451
452452** Returns** : ` Promise ` - A promise that returns the call response object, or an Error if rejected.
453453
454454## getOrgUsers
455455
456456##### accessControl.getOrgUsers(\[ orgName\] ) ⇒ ` Promise `
457457
458- \- - TerminusCMS and TerminusDB API -- Get all the organization's users and roles,
458+ \- - TerminusDB and TerminusDB API -- Get all the organization's users and roles,
459459
460460** Returns** : ` Promise ` - A promise that returns the call response object, or an Error if rejected.
461461
@@ -479,7 +479,7 @@ accessControl.getOrgUsers().then(result=>{
479479})
480480
481481// this function will return an array of capabilities with users and roles
482- // -- TerminusCMS -- response array example
482+ // -- TerminusDB -- response array example
483483// [{capability: "Capability/3ea26e1d698821c570afe9cb4fe81a3......"
484484// email: {@type: "xsd:string", @value: "[email protected] "}485485// picture: {@type: "xsd:string",…}
@@ -506,7 +506,7 @@ accessControl.getOrgUsers().then(result=>{
506506
507507##### accessControl.getTeamUserRoles(\[ userName\] , \[ orgName\] ) ⇒ ` Promise `
508508
509- \- - TerminusCMS and TerminusDB API -- Get the user roles for a given organization or the default organization,
509+ \- - TerminusDB and TerminusDB API -- Get the user roles for a given organization or the default organization,
510510
511511** Returns** : ` Promise ` - A promise that returns the call response object, or an Error if rejected.
512512
@@ -561,7 +561,7 @@ accessControl.getTeamUserRole("myUser").then(result=>{
561561
562562##### accessControl.ifOrganizationExists(orgName) ⇒ ` Promise `
563563
564- \- - TerminusCMS API --- Check if the organization exists. it is a Head call . IMPORTANT This does not work with the API-TOKEN.
564+ \- - TerminusDB API --- Check if the organization exists. it is a Head call . IMPORTANT This does not work with the API-TOKEN.
565565
566566** Returns** : ` Promise ` - A promise that returns the call status object, 200: if the organization exists and 404: if the organization does not exist
567567
@@ -581,7 +581,7 @@ The organization name to check if exists.
581581
582582##### accessControl.createOrganizationRemote(orgName) ⇒ ` Promise `
583583
584- \- - TerminusCMS API ---
584+ \- - TerminusDB API ---
585585
586586IMPORTANT This does not work with the API-TOKEN. Create an organization
587587
@@ -611,7 +611,7 @@ accessControl.createOrganization("my_org_name").then(result=>{
611611
612612##### accessControl.getPendingOrgInvites(\[ orgName\] ) ⇒ ` Promise `
613613
614- \- - TerminusCMS API ---
614+ \- - TerminusDB API ---
615615
616616Get the pending invitations list.
617617
@@ -651,7 +651,7 @@ cb0988d992c4bce82b3fa5d25"
651651
652652##### accessControl.sendOrgInvite(userEmail, role, \[ note\] , \[ orgName\] ) ⇒ `Promise`
653653
654- \- - TerminusCMS API ---
654+ \- - TerminusDB API ---
655655
656656Send a new invitation
657657
700700
701701##### accessControl.getOrgInvite(inviteId, \[ orgName\] ) ⇒ `Promise`
702702
703- \- - TerminusCMS API --- Get the invitation info
703+ \- - TerminusDB API --- Get the invitation info
704704
705705**Returns**: `Promise` - A promise that returns the call response object, or an Error if rejected.
706706
@@ -736,7 +736,7 @@ accessControl.getOrgInvite(fullInviteId).then(result=>{
736736
737737##### accessControl.deleteOrgInvite(inviteId, \[ orgName\] ) ⇒ `Promise`
738738
739- \- - TerminusCMS API ---
739+ \- - TerminusDB API ---
740740
741741Delete an invitation
742742
@@ -774,7 +774,7 @@ accessControl.deleteOrgInvite(fullInviteId).then(result=>{
774774
775775##### accessControl.updateOrgInviteStatus(inviteId, accepted, \[ orgName\] ) ⇒ `Promise`
776776
777- \- - TerminusCMS API ---
777+ \- - TerminusDB API ---
778778
779779Accept /Reject invitation. if the invitation has been accepted we add the current user to the organization.
780780
@@ -820,7 +820,7 @@ accessControl.updateOrgInviteStatus(fullInviteId,true).then(result=>{
820820
821821##### accessControl.getTeamUserRole(\[ orgName\] ) ⇒ `Promise`
822822
823- \- - TerminusCMS API ---
823+ \- - TerminusDB API ---
824824
825825Get the user role for a given organization or the default organization The user is identified by the jwt or the access token
826826
@@ -853,7 +853,7 @@ accessControl.getTeamUserRole().then(result=>{
853853
854854##### accessControl.removeUserFromOrg(userId, \[ orgName\] ) ⇒ `Promise`
855855
856- \- - TerminusCMS API -- Remove an user from an organization, only an admin user can remove an user from an organization
856+ \- - TerminusDB API -- Remove an user from an organization, only an admin user can remove an user from an organization
857857
858858**Returns**: `Promise` - A promise that returns the call response object, or an Error if rejected.
859859
@@ -887,7 +887,7 @@ accessControl.removeUserFromOrg("User/auth0%7C613f5dnndjdjkTTT","my_org_name").t
887887
888888##### accessControl.getDatabaseRolesOfUser(userId, \[ orgName\] ) ⇒ `Promise`
889889
890- \- - TerminusCMS API --
890+ \- - TerminusDB API --
891891
892892Get the user's role for every databases under the organization
893893
@@ -939,7 +939,7 @@ same of the team
939939
940940##### accessControl.createUserRole(userId, scope, role, \[ orgName\] ) ⇒ `Promise`
941941
942- \- - TerminusCMS API --
942+ \- - TerminusDB API --
943943
944944Create a user's a role for a resource (organization/database)
945945
@@ -990,9 +990,9 @@ accessControl.assignUserRole('User/auth0%7C61790e11a3966d006906596a',dbId,
990990
991991##### accessControl.updateUserRole(userId, capabilityId, scope, role, \[ orgName\] ) ⇒ `Promise`
992992
993- \- - TerminusCMS API --
993+ \- - TerminusDB API --
994994
995- Update user's a role for a resource (organization/database), (this api works only in TerminusCMS )
995+ Update user's a role for a resource (organization/database), (this api works only in TerminusDB )
996996
997997**Returns**: `Promise` - A promise that returns the call response object, or an Error if rejected.
998998
@@ -1048,7 +1048,7 @@ accessControl.updateUserRole('User/auth0%7C61790e11a3966d006906596a',capId,dbId,
10481048
10491049##### accessControl.accessRequestsList(\[ orgName\] ) ⇒ `Promise`
10501050
1051- \- - TerminusCMS API --
1051+ \- - TerminusDB API --
10521052
10531053Get all the access request list for a specify organization
10541054
@@ -1078,7 +1078,7 @@ accessControl.accessRequestsList().then(result=>{
10781078
10791079##### accessControl.sendAccessRequest(\[ email\] , \[ affiliation\] , \[ note\] , \[ orgName\] ) ⇒ `Promise`
10801080
1081- \- - TerminusCMS API --
1081+ \- - TerminusDB API --
10821082
10831083Get all the access request list for a specify organization
10841084
11291129
11301130##### accessControl.deleteAccessRequest(\[ orgName\] ) ⇒ `Promise`
11311131
1132- \- - TerminusCMS API --
1132+ \- - TerminusDB API --
11331133
11341134Delete an access request to join your team, only an admin user can delete it
11351135
0 commit comments