Page tree

Contents

An Organization Administrator (OrgAdmin) user management role is available to organizations in TIDE. This role is provisioned at the time the account is created, or upon request for organizations previously created without the organization admin role implemented. Please note, an OrgAdmin can only update or edit user accounts within their own organization. Only an organization administrator (OrgAdmin) can manage users in the organization and has access to the user management tools. 

As an OrgAdmin, you can manage users within your own organization. The org administrator can perform the following tasks:

  • View a list of all users in the organization along with their account information.
  • Invite a new user.
  • Update or change user information.
  • Update or change a user’s role.
  • Reset a user’s password.
  • Activate or deactivate all other users within the organization.
  • Can grant other users within the organization the role of OrgAdmin.


Managing Users using the UI

To manage an organization’s users using the UI, do the following:

From the TIDE dashboard, navigate to the User Management page (your user name > Admin > User Management). A listing of the organization’s current users will be displayed in the Users panel located on the left-hand side of the page.

Inviting a New User

  1. Click Add New User and the Invite A New User panel will be displayed.
  2. Select which role(s) the new user will be assigned. Multiple roles may be assigned by holding down the Shift key on your keyboard while selecting more than one user role.
  3. Fill out the First Name, Last Name, and Email fields.
  4. Click the Invite button to invite the new user. When the pop-up window appears confirming your intent to create a new user, click on the Submit button to continue.
  5. From the New User Credentials pop-up window, copy and paste the new user’s log on credentials into an email addressed to the user, before clicking OK.
  6. Verify in the Users panel that the new user’s account has been created as intended.

Updating the Account of a Current User

  1. Click on the user’s name under Users and the View User panel will be displayed.
  2. Click on the Edit button in the View User panel to open the Edit User panel.
  3. Select the types of edits you wish to make to the user’s account. The types of edits that can be made include edits in the user’s role, changes to the user’s account information, resetting the user’s password, and activating/deactivating the user’s account.
  4. Once the desired edits/changes have been made to the user’s account, click on the Update button to apply changes to the user’s account.
  5. In the Update User pop-up window, click OK to confirm you want to update the user’s account.
  6. Verify in the Users panel that the user’s account has been updated as intended.


Managing Users using the API

To manage an organization’s users using the API, do the following:

Adding a New User

This API call adds a new user to the caller’s organization. The person making the call must be assigned the role of "OrgAdmin” to make the call.

Request endpoint

POST /api/admin/accounts/org/users

Request Body
FieldTypeDescription
emailstringUser email, 8 – 512 characters, required
firstNamestringUser first name, 8 – 512 characters, required
lastNamestringUser last name, 8 – 512 characters, required
passwordstringUser password, 8 – 72 characters, optional. A mix of upper and lower-case characters, numbers and non-alphanumerics
rolesArray of stringsList of user roles available: DataAdmin, DataUser, DataWriter, Reports, OrgAdmin

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object that includes the API key generated for the user.

Example

Using curl to add a user to the caller’s organization.

curl
 -H "Content-Type":"application/json" -u [YOUR_API_KEY]: -X POST 
"https://api.activetrust.net:8000/api/admin/accounts/org/users" -d 
'{"email":"djfrosh@bankorg.net","firstName":"DJ", "lastName":"Frosh", 
"password":"djFr#shL1te", "roles":["DataAdmin", "DataUser", 
"DataWriter","Reports"]}'
Response:

{
  "code": 0,
  "status": "success",
  "data": {
    "httpCode": 201,
    "data": {
      "code": 0,
      "status": "success",
      "data": {
        "email": "djfrosh@bankorg.net",
        "uid": "djfrosh@bankorg.net",
        "oid": "BankOrg",
        "apiKey": "a7d8ab2a43b6406bbd8c4f3d33698e9f6087e81fc34c4e4199d5c4ecbbc0f502"   
      }
    }
  }
}

Updating a User’s Information

This API call allows the editing of a current user to the caller’s organization. The person making the call must possess the role of "OrgAdmin” to make the call.

Request endpoint

PUT /api/admin/accounts/org/user/{user_id}

It is required to have at least one of the below fields:

Request Body
FieldTypeDescription
firstNamestringUser first name, 1 – 512 characters
lastNamestringUser last name, 1 – 512 characters
Path Parameters
FieldTypeDescription
user_idstringUser email, targeted user to be updated

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object.

Example

Using curl to update firstName and lastName for user djfrosh@bankorg.net

curl
 -H "Content-Type":"application/json" -u [YOUR_API_KEY]: -X PUT 
"https://api.activetrust.net:8000/api/admin/accounts/org/user/djfrosh@bankorg.net"
 -d '{"firstName":"Dokta", "lastName":"Fresh"}'
Response:

{
  "code": 200,
  "status": "success"
}

Updating a User’s Role

This API call allows the updating of a current user’s role within the caller’s organization. The person making the call must possess the role of ‘OrgAdmin” to make the call.

Request

Request endpoint

PUT /api/admin/accounts/org/user/{user_id}/roles

Request Body

Request Body
FieldTypeDescription
rolesArray of stringList of user roles available: DataAdmin, DataUser, DataWriter, Reports, OrgAdmin

Path Parameters

Path Parameters
FieldTypeDescription
user_idstringUser email, targeted user to be updated

Response

If the submission is successful, the HTTP code 200 (OK) will be returned with a JSON response object.

Example

Using curl to update roles for user djfrosh@bankorg.net.

curl
 -H "Content-Type":"application/json" -u [YOUR_API_KEY]: -X PUT 
"https://api.activetrust.net:8000/api/admin/accounts/org/user/djfrosh@bankorg.net/roles"
 -d '{"roles":["DataAdmin", "DataUser"]}'
Response:

{
  "code": 200,
  "status": "success"
}

Activating/Deactivating a User’s Account

Using this API call, a user’s account within the caller’s organization can be activated or deactivated. The person making the call must possess the role of "OrgAdmin” to make the call.

Request endpoint

PUT /api/admin/accounts/org/user/{user_id}/active/{is_active}

Payload

N/A

Path Parameters
FieldTypeDescription
user_idstringUser email, targeted user to be updated
is_activebooleanUser status, true to activate user, false to deactivate user

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object.

Example

curl -u [YOUR_API_KEY]: -X PUT "https://api.activetrust.net:8000/api/admin/accounts/org/user/djfrosh@bankorg.net/active/true"
Response: 
{
    "code": 0,
    "status": "success",
    "data": {
      "auth": {
        "httpCode": 200,
        "data": {
          "code": 0,
          "status": "success"
       }
    },
    "admin": {
      "httpCode": 200,
      "data": {
        "code": 200,
        "status": "success"
      }
    }
  }
}

Resetting a User’s Password

Using this API call a user’s password can be reset within the caller’s organization. The person making the call must possess the role of ‘OrgAdmin” to make the call.

Request

Request endpoint

POST /api/auth/credentials/password/reset/{user_id}

Payload

Request Body
FieldTypeDescription
new_passwordstringNew password. Required.
8 – 72 characters. At least one uppercase. At least one lowercase. At least one number. At least one special character (specified below) or space: !”#$%&'()*+,-./:;<=
Path Parameters
FieldTypeDescription
user_idstringUser email, targeted user to be updated

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object.

Example

curl -H “Content-Type”:”application/json” -u [YOUR_API_KEY]: -X POST https://api.activetrust.net:8000/api/auth/credentials/password/reset/djfrosh@bankorg.net -d ‘{“new_password”: “Test.Pass.1”}’
Response:
{
  "code": 200,
  "status": "success"
}

Get User list

Using this API call a list of all the users within the caller’s organization may be obtained. The person making the call must possess the role of "OrgAdmin" to make the call.

Request endpoint

GET /api/admin/accounts/org/users

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object. The root key of the object is “data”. The value of the root object is an array of user objects containing user profile, roles, and active status.

Example

curl -X GET -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/accounts/org/users
Response:

{
  "code": 0,
   "status": "success",
   "data": [
     {
       "id": "j.j@BankOrg.net",
       "status": "inactive",
       "profile": {
         "email": "j.j@BankOrg.net",
         "fullName": "John Jones",
         "firstName": "John",
         "lastName": "Jones",
         "rolestring": "DataAdmin | DataUser | DataWriter | Reports"
       },
       "roles": [
         "DataAdmin",
         "DataUser",
         "DataWriter",
         "Reports"
       ]
     },
     {
       "id": "j.joans@BankOrg.net",
       "status": "inactive",
       "profile": {
         "email": "j.joans@BankOrg.net",
         "fullName": "Jon joans",
         "firstName": "Jon",
         "lastName": "joans",
         "rolestring": "DataAdmin | DataUser | DataWriter | Reports"
       },
       "roles": [
         "DataAdmin",
         "DataUser",
         "DataWriter",
         "Reports"
       ]
} 
}
   ]
 }

Get Available Roles for an Organization

Using this API call, all available user roles within the caller’s organization may be obtained. The person making the call must possess the role of "OrgAdmin” to make the call.

Request endpoint

GET /api/admin/accounts/org/roles

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a JSON object.

Example

Request using curl to return available roles for the caller’s organization.

curl GET -u [YOUR_API_KEY]: “https://api.activetrust.net:8000/api/admin/accounts/org/roles
Response:

{
  "code": 200,
   "status": "success",
   "data": [
     {
       "name": "DataAdmin",
       "description": "Data sharing administrators",
       "org": "TEST_ORG"
     },
     {
       "name": "DataUser",
       "description": "Organization data users",
       "org": "TEST_ORG"
     },
     {
       "name": "DataWriter",
       "description": "Organization data users",
       "org": "TEST_ORG"
     },
     {
       "name": "OrgAdmin",
       "description": "Organization administrators",
       "org": "TEST_ORG"
     },
     {
       "name": "Reports",
       "description": "Access to organization reports",
       "org": "TEST_ORG"
     },
     {
       "name": "User",
       "description": "Organization users",
       "org": "TEST_ORG"
     }
   ]
 }


  • No labels

This page has no comments.