| Table of Contents | ||
|---|---|---|
|
Overview
This resource represents groups and users that are in your organization. The Home> Admin>Users page enables you to invite and create users, and view their details. In this page , you can also remove users, assign pending tasks and send activation email messages.
This document showcases the API requests and responses for:
getting all groups and users in an organization
creating groups and users
inviting users to your organization
adding and removing users to/from groups
removing users from an organization
getting organization-level and product-level role assignments
assigning an organization-level or product-level role to specific users or to a group of users according to specific roles
creating a service user
regenerating a user token for a service user
getting all organization and product service users
inviting an external user to download and use Mend Advise for Chrome
Get Groups
NOTE: To get all groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that returns all the groups in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "getAllGroups",
"userKey": "user_key",
"orgToken": "organization_api_key"
} |
Response Example
The response is a JSON collection of all the groups with their details in the organization. For example:
| Code Block |
|---|
{
"groups":[
{
"id": 2373,
"name": "admins",
"description": "Alex playground administrators",
"users":[
{"id": 2458, "email": "john1@gmail.com", "name": "John2"},
{"id": 1841, "email": "john2@gmail.com", "name": "John1"}
]}],
"message":"Organization groups"
} |
Get Users
NOTE: To get all users in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that returns all the users in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "getAllUsers",
"userKey": "user_key",
"orgToken": "organization_api_key"
} |
Response Example
The response is a JSON collection of all the users with their details in the organization. For example:
| Code Block |
|---|
{
"users":[
{
"id": 1841,
"email": "john@gmail.com",
"name": "John Doe"
}],
"message":"Organization users"
} |
Create a Group
NOTE: To create groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that creates a group in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
group
...
Group data object containing:
...
name
...
Name of the group that you want to create.
...
string
...
Yes
...
description
...
Description of the group you want to create.
...
string
...
No
Request Example
...
| Code Block |
|---|
{
"requestType": "createGroup",
"userKey": "user_key",
"orgToken": "organization_api_key",
"group":{
"name":"group_name",
"description":"group_description"
}
} |
Response Example
The response shows the details of the newly created group for which a unique ID was created. For example:
...
| Code Block |
|---|
{
"group":{
"id": 8340,
"name": "test_group",
"description": "best group ever",
"users":[]
},
"message": "Successfully created group test_group"
} |
Create a User
NOTE: To create a user in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that creates a user in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
inviter
...
Data object containing:
...
...
Email address of the user that is sending the invitation to the new user.
...
string
...
Yes
...
addedUser
...
New user data object containing:
...
name
...
Name of the user to be added.
...
string
...
Yes
...
...
Email address of the user to be added.
...
string
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "createUser",
"userKey": "user_key",
"orgToken": "organization_api_key",
"inviter":{
"email": "inviter_email"
},
"addedUser":{
"name":"new_user_name",
"email":"new_user_email"
}
} |
Response Example
| Code Block |
|---|
"message":"Successfully created user new_user_name" |
Invite Users to your Organization
NOTE: To invite users to join an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that sends an invitation to new users to join an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
inviter
...
Data object containing:
...
...
Email address that is “inviting” the new users.
...
string
...
Yes
...
emails
...
List of activation email addresses for the new users.
...
array
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "inviteUsers",
"userKey": "user_key",
"orgToken": "organization_api_key",
"inviter":{
"email":"inviter_email"
},
"emails":[
"new_email1",
"new_email2"
]
} |
Response Example
...
| Code Block |
|---|
"message":"Successfully sent invitation to new_email1, new_email2" |
Adding Users to Groups
NOTE: To add users to groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that adds users to groups in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
assignedUsers
...
Data object listing the users that you want to assign to groups:
...
array
...
Yes
...
name
...
Name of the group to which you are adding the users.
...
string
...
Yes
...
...
List of email activation addresses of users you want to assign to the group.
...
array
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "addUsersToGroups",
"userKey": "user_key",
"orgToken": "organization_api_key",
"assignedUsers" :
[
[{"name":"group_name"},[{"email":"assigned_user_email"},
{"email":"assigned_user_email"}]]
]
} |
Response Example
| Code Block |
|---|
"message":"Successfully assigned users to groups" |
Removing Users from Groups
NOTE: To remove a user from a group in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that removes a user from a group in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
group
...
Name of the group from which the user will be removed.
...
string
...
Yes
...
user
...
Name of the user that will be removed from the group.
...
string
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "removeUserFromGroup",
"userKey": "user_key",
"orgToken": "your_org_token",
"group": { "name": "group_name" },
"user": { "email": "user_email" }
} |
Response Example
| Code Block |
|---|
"message":"Successfully removed user from group" |
Removing a User from an Organization
NOTE: To remove a user from an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that removes a user from an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
user
...
Email address of the user that will be removed from the organization.
...
string
...
Yes
Request Example
...
| Code Block |
|---|
{
"requestType": "removeUserFromOrganization",
"userKey": "user_key",
"orgToken":"your_org_token",
"user": { "email": "user_email" }
} |
Response Example
| Code Block |
|---|
"message":"Successfully removed user from organization" |
Get Organization Assignments
NOTE: To get organization-level role assignments, you must have ORG Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that gets all role assignments in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType":"getOrganizationAssignments",
"userKey": "user_key",
"orgToken":"organization_api_key"
} |
Response Example
The JSON response shows the details of the assignments for different roles in the organization. For example:
| Code Block |
|---|
{
"groupRoles":{
"USER":[
{
"id":group_id,
"name":"users",
"description":"All users in organization",
"users":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
},
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
],
"ADMIN":[
{
"id":group_id,
"name":"admins",
"description":"Administrators",
"users":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
]
},
"userRoles":{
"USER":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
},
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
],
"DEFAULT_APPROVER":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
} |
Get Product Assignments
NOTE: To get product-level role assignments, you must have Product Admin role permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that gets all role assignment in a product.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType":"getProductAssignments",
"userKey": "user_key",
"productToken":"product_token"
} |
Response Example
The JSON response shows the details of the assignments for different roles in the product. For example:
| Code Block |
|---|
{
"groupRoles":{
"ALERT_EMAIL_RECEIVER":[
{
"id":group_id,
"name":"group_name",
"description":"Email receivers",
"users":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
],
"ADMIN":[
{
"id":group_id,
"name":"group_name",
"description":"Administrators",
"users":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
],
"PRODUCT_INTEGRATOR":[
{
"id":group_id,
"name":"group_name",
"description":"Product Integrators",
"users":[
{
"id":user_id,
"email":"user_email",
"name":"user_name"
}
]
}
]
},
"userRoles":{
}
} |
Set Organization Assignments
You can assign an Organization-level role to specific users or to a group of users using API calls. The following roles are supported:
Administrators
Alert Email Receiver
Default Approver
Auditor
Administrator Role
Administrators have control over the entire organization. They can create, invite, and remove users, add products and projects, and much more.
This API enables you to assign the Administrator role to specific users and/or groups.
NOTE: Assigning the role of Administrator to individual users is not recommended; using groups is simpler and easier for user and role management.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the organization-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
administrators
...
Administrator role data object containing:
...
groupAssignments
...
List of groups to which you want to assign the Administrator role.
...
array
...
No
...
userAssignments
...
List of users to which you want to assign the Administrator role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setOrganizationAssignments",
"userKey": "user_key",
"orgToken": "organization_api_key",
"administrators" :
{
"groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following organization assignments have been set: Admins" |
Alert Email Receiver Role
This API enables you to assign the organization-level role Alert Email Receivers to specific users and/or groups.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the organization-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
alertsEmailReceivers
...
Alert Email Receiver role data object containing:
...
groupAssignments
...
List of groups to which you want to assign the Alert Email Receiver role.
...
array
...
No
...
userAssignments
...
List of users to which you want to assign the Alert Email Receiver role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setOrganizationAssignments",
"userKey": "user_key",
"orgToken": "organization_api_key",
"alertsEmailReceivers" :
{
"groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following organization assignments have been set: Alerts Email Receivers" |
Default Approver Role
All pending tasks in the organization are sent to the Default Approver. Changing the Default Approver only impacts future tasks. Existing tasks are assigned to their original Approver.
The organization must have a Default Approver at all times. The role of Default Approver is assigned to the organization creator by default, and any member of the organization can be assigned to this role.
This API enables you to assign the Default Approver role to specific users and groups in an organization.
NOTE: The Product level Default Approver overrides the Organization level Default Approver for their relevant Product(s).
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the organization-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
defaultApprovers
...
Default Approvers role data object containing:
...
groupAssignment
...
Group to which you want to assign the Default Approvers role.
...
string
...
No
...
userAssignment
...
Email address of specific user to which you want to assign the Default Approvers role.
...
string
...
No
...
groupAssignments
...
List of groups to which you want to assign the Default Approvers role.
NOTE: Only the first value in the array of groups will be assigned the role.
...
array
...
No
...
userAssignments
...
List of email addresses of users to which you want to assign the Default Approvers role.
NOTE: Only the first value in the array of users will be assigned the role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setOrganizationAssignments",
"userKey": "user_key",
"orgToken": "organization_api_key",
"defaultApprovers" :
{
"groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following organization assignments have been set: Default Approvers" |
Auditor Role
The Auditor role can be assigned to service users to grant them Read-only permissions in the scope of a specific organization. It is recommended to use this role when you want service users to obtain organizational information, but you don't want to grant them full Admin permissions.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the organization-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
readOnlyUsers
...
Auditor role data object to grant read-only permissions:
...
groupAssignments
...
List of groups to which you want to assign the Auditor role.
...
array
...
No
...
userAssignments
...
List of users to which you want to assign the Auditor role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType" : "setOrganizationAssignments",
"userKey":"admin_user_key"
"orgToken" : "organization_api_key",
"readOnlyUsers" :
{
"groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
}
} |
Response Example
| Code Block |
|---|
"message": "The following organization assignments have been set: Read Only" |
Set Product Assignments
You can assign a Product-level role to specific users or to a group of users using API calls. The following roles are supported:
Product Administrator
Alert Email Receivers
Product Membership
Product Default Approvers
Product Integrators
Product Administrator Role
Product Administrators have control over the entire product, they can rename and delete the product, and all the projects under it.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the product-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
...
productAdmins
...
Product Administrator role data object containing:
...
userAssignments
...
List of users to which you want to assign the Product Administrator role.
...
array
...
No
...
groupAssignments
...
List of groups to which you want to assign the Product Administrator role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setProductAssignments",
"userKey": "user_key",
"productToken": "product_token",
"productAdmins" :
{
"userAssignments":[{"email":"user_email"}],
"groupAssignments":[{"name":"group_name"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following product assignments have been set: Admins" |
Alert Email Receivers Role
This API enables you to assign the Alert Email Receivers product-level role to specific users and/or groups.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the product-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
...
alertsEmailReceivers
...
Alert Email Receivers role data object containing:
...
userAssignments
...
List of users to which you want to assign the Alert Email Receivers role.
...
array
...
No
...
groupAssignments
...
List of groups to which you want to assign the Alert Email Receivers role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setProductAssignments",
"userKey": "user_key",
"productToken": "product_token",
"alertsEmailReceivers" :
{
"userAssignments":[{"email":"user_email"}],
"groupAssignments":[{"name":"group_name"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following product assignments have been set: Alerts Email Receivers" |
Product Membership Role
Product members can view the product data and all its projects, and open tickets for libraries. By default, all users in the organization are members of the product - by assigning a user as a member of the product all other users will be excluded.
This API enables you to assign the Product Membership product-level role to specific users and/or groups.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the product-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
...
productMembership
...
Product Membership role data object containing:
...
userAssignments
...
List of users to which you want to assign the Product Membership role.
...
array
...
No
...
groupAssignments
...
List of groups to which you want to assign the Product Membership role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setProductAssignments",
"userKey": "user_key",
"productToken": "product_token",
"productMembership" :
{
"userAssignments":[{"email":"user_email"}],
"groupAssignments":[{"name":"group_name"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following product assignments have been set: Membership" |
Product Default Approvers Role
If the role of Product Approver is not assigned, all product tickets are sent to the organization’s Default Approvers. Any member of the organization can be assigned to this role. You can also assign the Default Approvers to a specific group. Changing the Product Approver will only affect future pending tasks, existing tasks will still be assigned to their original approver.
The Product level Default Approver overrides the Organization level Default Approver for their relevant product(s).
This API enables you to assign the Default Approvers role to specific users and groups at the product-level.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the product-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
...
productApprovers
...
Product Approvers role data object containing:
...
userAssignment
...
Email address of specific user to which you want to assign the Default Approvers role.
...
string
...
No
...
groupAssignment
...
Group to which you want to assign the Default Approvers role.
...
string
...
No
...
userAssignments
...
List of email addresses of users to which you want to assign the Default Approvers role.
NOTE: Only the first value in the array of users will be assigned the role.
...
array
...
No
...
groupAssignments
...
List of groups to which you want to assign the Default Approvers role.
NOTE: Only the first value in the array of groups will be assigned the role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setProductAssignments",
"userKey": "user_key",
"productToken": "product_token",
"productApprovers" :
{
"userAssignments":[{"email":"user_email"},{"email":"user_email"}],
"groupAssignment":[{"name":"group_name"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following product assignments have been set: Default Approvers" |
Product Integrators Role
Product Integrators can run a scan on a new or existing project within the product. They can also view data on the product and all its projects, and open tickets for libraries.
This API enables you to assign the Product Integrators product-level role to specific users and/or groups.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that assigns roles at the product-level.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
...
productIntegrators
...
Product Integrators role data object containing:
...
userAssignments
...
List of users to which you want to assign the Product Integrators role.
...
array
...
No
...
groupAssignments
...
List of groups to which you want to assign the Product Integrators role.
...
array
...
No
Request Example
| Code Block |
|---|
{
"requestType": "setProductAssignments",
"userKey": "user_key",
"productToken": "product_token",
"productIntegrators" :
{
"userAssignments":[{"email":"user_email"}],
"groupAssignments":[{"name":"group_name"}]
}
} |
Response Example
| Code Block |
|---|
"message":"The following product assignments have been set: Integrators" |
Service Users
Service Users communicate with Mend via the APIs for automation purposes; they cannot log in to the Web Console. Organization administrators manage Service Users via the GUI. You can assign a service user to one or more groups.
Create a Service User
This API enables an organization admin to create a service user and generate its user token and email address.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that creates a service user.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
addedUser
...
New service user data object containing:
...
name
...
Name of service user you want to create.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType": "createServiceUser",
"orgToken": "organization_api_key",
"userKey": "user_key",
"addedUser":{
"name":"ServiceUser2"
}
} |
Response Example
| Code Block |
|---|
{
"userToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
"userEmail": "service_user_email_address"
} |
Regenerate User Token for a Service User
This API allows an organization admin to regenerate the user token of a service user.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that regenerates a service user’s token key.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
serviceUserKey
...
Current token key for the service user.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType": "regenerateUserKey",
"orgToken": "organization_api_key",
"userKey": "user_key",
"serviceUserKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
} |
Response Example
| Code Block |
|---|
{
"userToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
} |
Get Organization Service Users
This API allows an organization admin to get a list of all the service users in an organization.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that returns all the service users in an organization.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType":"getOrganizationServiceUsers",
"userKey":"user_key",
"orgToken":"organization_api_key"
} |
Response Example
| Code Block |
|---|
{
"serviceUsers": [
{
"serviceUserName": "New_Service_User",
"serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"serviceUserName": "ServiceUser2",
"serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"serviceUserName": "WS_4_GHC_service_user",
"serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"serviceUserName": "service1",
"serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
} |
Get Product Service Users
This API allows an organization admin to get a list of all the service users in a product.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that returns all the service users in a product.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
productToken
...
Unique identifier of the product.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType":"getProductServiceUsers",
"userKey":"user_key",
"productToken":"product_token"
} |
Response Example
| Code Block |
|---|
{
"serviceUsers": [
{
"serviceUserName": "WS_4_GHC_service_user",
"serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
} |
Invite User to Mend Advise for Chrome
Mend Advise allows your developers to view a snapshot of a component’s details before they download it to their repository, and incorporate it in the codebase.
This API enables a Mend account administrator to invite an external user to download and use Mend Advise.
QUERY PARAMETERS
...
Parameter
...
Description
...
Type
...
Required
...
requestType
...
API request type that enables a Mend account administrator to invite an external user to download and use Mend Advise.
...
string
...
Yes
...
userKey
...
The ID of the user’s profile, which uniquely identifies the user in Mend.
...
string
...
Yes
...
orgToken
...
API key which is a unique identifier of the organization.
...
string
...
Yes
...
userEmail
...
Email address of the external user who will receive the invitation via email.
...
string
...
Yes
Request Example
| Code Block |
|---|
{
"requestType" : "inviteUserToWebAdvisor",
"userKey": "user_key",
"orgToken" : "organization_api_key",
"userEmail": "User email address"
} |
Response Example
| Code Block |
|---|
{ "message": "Successfully invited external user" } |
Back to topis available at: https://docs.mend.io/bundle/api/page/groups_and_users_api.html