AdminApi
Used to retrieve an authentication token for NexPort API Requests. Will not work for system operators or users with the customer service role. The client makes a request to the token endpoint by adding the following parameters using the "application/x-www-form-urlencoded" format per Appendix B with a character encoding of UTF-8 in the HTTP request entity-body.
Contains information for obtaining an authentication token
Username for user requesting token
Password for user requesting token
Only "password" is supported currently
Scope of the access request
Optional expiration date for the token (set to null for no expiration)
Authentication Token Information
Unable to authenticate
Validation exception. See response body for more info.
POST /api/v1/AdminApi/Authenticate HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"username": "text",
"password": "text",
"grant_type": "text",
"scope": "text",
"utc_expiration_date": "2025-09-13T11:10:18.678Z"
}{
"access_token": "00000000-0000-0000-0000-000000000000",
"token_type": "text",
"expires_in": 1,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Used to determine whether an access token is valid or not. Returns either the expiration date or
a message describing why the token is invalid. If there is no expiration on the token, then
it will just return the generic api_error_entity with the no error error code.
Validation results
Validation exception. See response body for more info.
GET /api/v1/AdminApi/ValidateAccessToken HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
{
"utc_expiration_date": "2025-09-13T11:10:18.678Z",
"error_message": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Creates a user with the information specified by request. Requires the Create Users permission
in the specified owner org or any ancestors.
Use the AdminApi Authenticate method to get the access_token
Contains fields for creating a new user
Id of the user's owner organization
00000000-0000-0000-0000-000000000000The login for this account
The password for this account
First name of the user
Middle name of the user
Last name of the user
Email address of the user
User's title prefix
User's nickname
Id of created user
Not authorized to create a user
Entity not found or duplicate login
Validation exception
POST /api/v1/AdminApi/CreateUser HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 448
{
"owner_org_id": "00000000-0000-0000-0000-000000000000",
"login": "text",
"password": "text",
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"email": "text",
"title": "text",
"nickname": "text",
"contact_info": {
"address_line_1": "text",
"address_line_2": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"mobile": "text",
"fax": "text",
"caption": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text"
}
}
}{
"user_id": "00000000-0000-0000-0000-000000000000",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Gets a user based on login string OR user id. Requires the View Users permission in either the user's
owner org, its ancestors, or any of the user's subscription organizations, or their ancestors.
Login of the user to get
Use the AdminApi Authenticate method to get the access_token
User information
Not authorized to view users
Entity not found
Validation exception
GET /api/v1/AdminApi/GetUser HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
{
"user_id": "00000000-0000-0000-0000-000000000000",
"owner_org_id": "00000000-0000-0000-0000-000000000000",
"owner_org_short_name": "text",
"last_name": "text",
"middle_name": "text",
"first_name": "text",
"email": "text",
"internal-email": "text",
"title": "text",
"nickname": "text",
"owner_org_name": "text",
"owner_org": {
"org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
},
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Validates a user's login/password combination and returns a user response. The calling account must have the view users permision in the user's owner org or one of their subscription orgs.
User's nexport username
User's password
Use the AdminApi Authenticate method to get the access_token
User information
Not authorized to view users
Entity not found
Validation exception
GET /api/v1/AdminApi/AuthenticateUser HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
{
"user_id": "00000000-0000-0000-0000-000000000000",
"owner_org_id": "00000000-0000-0000-0000-000000000000",
"owner_org_short_name": "text",
"last_name": "text",
"middle_name": "text",
"first_name": "text",
"email": "text",
"internal-email": "text",
"title": "text",
"nickname": "text",
"owner_org_name": "text",
"owner_org": {
"org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
},
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Returns all the users with at least a partial match to the search term as part of their login,
first name, last name, or email. Sorted by last name, first name, then login, in alphabetical order.
This will only search in organizations in which the method caller has the appropriate permissions.
Requires the View Users permission.
Which page of results to start on
Use the AdminApi Authenticate method to get the access_token
List of users
Not authorized to view users
Validation exception. See response body for more info.
GET /api/v1/AdminApi/GetUsers HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"user_id": "00000000-0000-0000-0000-000000000000",
"owner_org_id": "00000000-0000-0000-0000-000000000000",
"owner_org_short_name": "text",
"last_name": "text",
"middle_name": "text",
"first_name": "text",
"email": "text",
"internal-email": "text",
"title": "text",
"nickname": "text",
"owner_org_name": "text",
"owner_org": {
"org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
},
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Get contact information for a user based on their user id or their login. Throws a ValidationException
if both user_id and login fields are present.
Requires the View User Profiles permission in either the user's owner org, its ancestors, or any of the
user's subscription organizations, or their ancestors.
Login of the user to get the contact information for
Use the AdminApi Authenticate method to get the access_token
Address and contact information
Not authorized to view user contact information
Entity not found
Validation exception
GET /api/v1/AdminApi/GetUserContactInformation HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
{
"user_id": "00000000-0000-0000-0000-000000000000",
"address_line_1": "text",
"address_line_2": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"mobile": "text",
"fax": "text",
"caption": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Creates a group under the given parent group or organization. Requires the AddGroup permission
in the specified parent or one of it's ancestors.
Use the AdminApi Authenticate method to get the access_token
The name of the new group
Short name must be unique within the system...if any other groups have the same group name then an error will be thrown
Any string value that can be used for tracking groups later
Description of the group
ID of the group or organization that this new group will be created under.
00000000-0000-0000-0000-000000000000Id of created group
Not authorized to create a group in the given parent
Entity not found or duplicate login
Validation exception. See response body for more info.
POST /api/v1/AdminApi/CreateGroup HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"name": "text",
"short_name": "text",
"billing_code": "text",
"description": "text",
"parent_id": "00000000-0000-0000-0000-000000000000"
}{
"group_id": "00000000-0000-0000-0000-000000000000",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Creates memberships in each of the given groups. This call is atomic. If one membership creation fails then they will all fail. Requires the AddMembership permission
in the specified group or one of it's ancestors.
Use the AdminApi Authenticate method to get the access_token
Create membership request object
The the groups to give the user a membership in
ID of the user to give memberships in each of the listed groups. The user must have subscriptions in the orgs that the groups belong to.
00000000-0000-0000-0000-000000000000Memberships were successfully created
Not authorized to add memberships to the given group
Entity not found or duplicate login
Validation exception. See response body for more info.
POST /api/v1/AdminApi/CreateMembership HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 100
{
"groups": [
"00000000-0000-0000-0000-000000000000"
],
"user_id": "00000000-0000-0000-0000-000000000000"
}{
"memberships": [
{
"membership_id": "00000000-0000-0000-0000-000000000000",
"group_id": "00000000-0000-0000-0000-000000000000"
}
],
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Remove memberships in each of the given groups. This call is atomic. If one membership removal fails then they will all fail.
Requires either a user Id and the list of group Ids OR the list of membership Ids.
###Permission requirements Requires the RemoveMemberships permission in the specified group or one of it's ancestors.
Use the AdminApi Authenticate method to get the access_token
Remove membership request object
The list of membership group Ids to be removed
The user Id that will be used to remove the group membership(s)
00000000-0000-0000-0000-000000000000The list of membership Ids to be removed
Memberships were successfully removed
Not authorized to remove memberships from the given group
Entity not found or duplicate login
Validation exception. See response body for more info.
POST /api/v1/AdminApi/RemoveMembership HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 155
{
"groups": [
"00000000-0000-0000-0000-000000000000"
],
"user_id": "00000000-0000-0000-0000-000000000000",
"memberships": [
"00000000-0000-0000-0000-000000000000"
]
}{
"memberships": [
{
"membership_id": "00000000-0000-0000-0000-000000000000",
"group_id": "00000000-0000-0000-0000-000000000000"
}
],
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Edits user information (including contact information) based on given input. Use either user_id OR login to specify the user to edit. If a field is not passed in, the value will remain unchanged. ###Permission requirements
For editing your own profile:
Editing contact information requires the Edit User Profile permission.
For editing another profile:
Requires the View User Profiles permission.
Editing basic information (primary email, prefix title, nickname) requires the Edit User Profile permission.
Editing name (first, middle, last) requires the Edit User Profile permission AND the target user's owner organization must have Allow Admin User Edit set to true.
Editing contact information requires the Edit User Profile permission.
Use the AdminApi Authenticate method to get the access_token
Contains fields for editing a user's profile
Id of the user whose information is being edited. Use either this OR login.
00000000-0000-0000-0000-000000000000Login of the user whose information is being edited. User either this OR user_id.
First name of the user
Middle name of the user
Last name of the user
User's email address
User's title prefix
User's nickname
Edited user information
Not authorized to view/edit users
Entity not found
Validation exception
POST /api/v1/AdminApi/EditUser HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 425
{
"user_id": "00000000-0000-0000-0000-000000000000",
"login": "text",
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"email": "text",
"title": "text",
"nickname": "text",
"contact_info": {
"address_line_1": "text",
"address_line_2": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"mobile": "text",
"fax": "text",
"caption": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text"
}
}
}{
"user_id": "00000000-0000-0000-0000-000000000000",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Creates a subscription with the information specified by request. Requires the Add Subscriptions permission.
Use the AdminApi Authenticate method to get the access_token
Contains fields for creating a new subscription
Id of the subscription's organization
00000000-0000-0000-0000-000000000000The user id to create the subscription for
00000000-0000-0000-0000-000000000000Id of created subscription
Not authorized to create a subscription
Entity not found or duplicate subscription
Validation exception
POST /api/v1/AdminApi/CreateSubscription HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"org_id": "00000000-0000-0000-0000-000000000000",
"user_id": "00000000-0000-0000-0000-000000000000"
}{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Gets subscription information for the user in the organization. Valid parameter combinations are:
user_id and org_short_name
user_id and org_id
subscription_id
###Permissions Requires the View User Subscriptions permission in the subscription organization or an ancestor.
Use the AdminApi Authenticate method to get the access_token
Subscription information
Not authorized to view subscriptions
Entity not found
Validation exception
GET /api/v1/AdminApi/GetSubscription HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"user_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_name": "text",
"org_shortname": "text",
"utc_date_created": "2025-09-13T11:10:18.678Z",
"utc_date_updated": "2025-09-13T11:10:18.678Z",
"billing_code": "text",
"utc_expiration_date": "2025-09-13T11:10:18.678Z",
"is_disabled": true,
"subscription_status": {
"current_status_name": "text",
"previous_status_name": "text",
"status_date_set": "2025-09-13T11:10:18.678Z"
},
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Use either user_id OR login OR org_id. If searching by user, results will be ordered by the subscription UtcExpirationDate from earliest to latest. If searching by org, results will be ordered by the subscription user last name then first name in alphabetical order. Requires the View User Subscriptions permission in the target user's organization if viewing user subscriptions and the Add, Remove, or Update Subscriptions permission in the given organization if viewing organization subscriptions.
Login of the user to get subscriptions for
Which page of results to start on
Use the AdminApi Authenticate method to get the access_token
List of subscriptions
Not authorized to view subscriptions
Entity not found
Validation exception
GET /api/v1/AdminApi/GetSubscriptions HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"user_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_name": "text",
"org_shortname": "text",
"utc_date_created": "2025-09-13T11:10:18.678Z",
"utc_date_updated": "2025-09-13T11:10:18.678Z",
"billing_code": "text",
"utc_expiration_date": "2025-09-13T11:10:18.678Z",
"is_disabled": true,
"subscription_status": {
"current_status_name": "text",
"previous_status_name": "text",
"status_date_set": "2025-09-13T11:10:18.678Z"
},
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]At least one user id OR one org id must be specified.
Results will be ordered by the subscription Creation Date from earliest to latest. ###Permissions Requires the View User Subscriptions permission in the target user's organization if viewing user subscriptions and the Add, Remove, or Update Subscriptions permission in the given organization if viewing organization subscriptions.
The request page of results
Number of results to return on each page
Use the AdminApi Authenticate method to get the access_token
Limit the results to only subscriptions for these users
Limit the results to only subscriptions to these organizations
Only return subscriptions expiring before this date
Only return subscriptions expiring after this date
Only return subscriptions createa before this date
Only return subscriptions created AFTER this date
Subscription search results successfully returned
Not authorized to view subscriptions
Entity not found
Validation exception
POST /api/v1/AdminApi/SearchSubscriptions HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 386
{
"user_ids": [
"27c2cbbf-5ad9-4340-bf21-d2a4db371e04",
"9b26cafe-a14e-4b47-9bfb-cdba65a479a9"
],
"org_ids": [
"cad4a303-cf06-4321-bd00-5db3d468f740",
"a53924e4-6e31-4e03-8b8e-8eb395fbead7"
],
"utc_expires_before": "2025-09-13T08:19:43.8672092Z",
"utc_expires_after": "2027-09-13T08:19:43.8672092Z",
"utc_create_before": "2025-09-12T08:19:43.8672092Z",
"utc_create_after": "2025-08-24T08:19:43.8672092Z"
}{
"subscriptions": [
{
"id": "00000000-0000-0000-0000-000000000000",
"subscription_id": "00000000-0000-0000-0000-000000000000",
"user_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_name": "Test Organization",
"org_shortname": "testorg",
"utc_date_created": "0001-01-01T00:00:00",
"is_disabled": false,
"api_error_entity": {
"error_code": 0,
"warning_messages": []
}
}
],
"page": 5,
"page_size": 15,
"total_count": 28,
"api_error_entity": {
"error_code": 0,
"warning_messages": []
}
}Enables or disables a subscription. Requires the Update Subscriptions permission in the subscription
organization or an ancestor.
Use the AdminApi Authenticate method to get the access_token
Contains information for enabling or disabling a subscription
Id of the subscription to enable or disable
00000000-0000-0000-0000-000000000000Enable or disable this subscription. Setting this to false enables the subscription. Setting it to true will disable it.
Whether the subscription is disabled after the method call
Not authorized to update subscriptions
Entity not found
Validation exception. See response body for more info.
POST /api/v1/AdminApi/DisableSubscription HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"disable": true
}{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"disabled": true,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Sets the subscription status for the supplied subscriber. Subscription status name is case sensitive and must be a pre existing status. This action will not create a status that does not exist. You can send an empty string for the subscription status if you want to set it back to the default subscription status. ###Permissions Requirements Requires the Update Subscriptions permission in the specified org or an ancestor.
Use the AdminApi Authenticate method to get the access_token
The Subscription Id
00000000-0000-0000-0000-000000000000The status that should be set on this subscription. Use empty string to set the subscription status to the default subscription status.
Subscription Id, Current Subscription Status, Previous Subscription Status, and the date the new Subscription Status was set
Not authorized to update subscriptions
Subscription or Subscription Status not found
Validation exception. See response body for more info.
POST /api/v1/AdminApi/SetSubscriptionStatus HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"subscription_status": "text"
}{
"subscription_id": "00000000-0000-0000-0000-000000000000",
"current_subscription_status": "text",
"previous_scubscription_status": "text",
"status_date_set": "2025-09-13T11:10:18.678Z",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Gets all the custom profile fields available to an organization, or a field matching an id in a given org.
Will throw a CustomFieldNotFound exception if no custom profile field exists with the given field id.
Use the AdminApi Authenticate method to get the access_token
List of custom profile fields
Entity not found
Validation exception. See response body for more info.
GET /api/v1/AdminApi/GetCustomProfileFields HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"field_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"key": "text",
"description": "text",
"type": 0,
"org_id": "00000000-0000-0000-0000-000000000000",
"org_short_name": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Gets the custom profile field values based on the given criteria, with DateTime fields being in UTC.
Valid argument combinations are: subscriber_id; user_id and org_id; subscriber_id and key; user_id, org_id, and key. Requires the View User Profiles permission for the subscription organization or an ancestor.
Key of the custom profile field to get the value for
Use the AdminApi Authenticate method to get the access_token
List of custom profile field values
Not authorized to view user profiles
Entity not found
Validation exception
GET /api/v1/AdminApi/GetCustomProfileFieldValues HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"name": "text",
"key": "text",
"value": "text",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_short_name": "text",
"field_id": "00000000-0000-0000-0000-000000000000",
"type": 0,
"utc_date_modified": "2025-09-13T11:10:18.678Z",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Sets the custom profile field values for a subscription based on
the subscriber id and key/value pairs in the request.
All fields that can be set will be set and any fields that are not found will be ignored. Warnings will be added to the {Nexport.WebApi.Model.v1.ApiErrorEntity} property's warnings collection and the ItemNotFound error code set. ###Permissions This method requires the Edit User Profile permission in the subscription organization or an ancestor.
Use the AdminApi Authenticate method to get the access_token
Contains id of the subscription and the custom fields/values to set
Id of the subscription to set the custom values for
00000000-0000-0000-0000-000000000000Error information
Not authorized to edit profiles
Entity not found
Validation exception. See response body for more info.
POST /api/v1/AdminApi/SetCustomProfileFieldValues HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 246
{
"subscriber_id": "f2a24534-6f54-4da8-801e-8d56deda0a3d",
"subscriber_pair": {
"user_id": "0c6111fb-0ded-4e95-aa65-c398c09b54da",
"org_id": "e573229b-0515-48e5-9a2f-da0639a59d01"
},
"custom_profile_field_values": {
"gender": "male",
"badge_number": "5434533"
}
}{
"message": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Returns a list of organizations and groups that matches the search term with their name or short name. Each item in the list will contain
the id of the organization/group, name, short name and the type.
Results are in alphabetical order by name followed by the short name.
0 = Disjunction, 1 = Conjunction
The organization/group name
Which page of results to start on
Use the AdminApi Authenticate method to get the access_token
List of organizations and groups
Entity not found
Validation exception
GET /api/v1/AdminApi/SearchDirectory HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"id": "00000000-0000-0000-0000-000000000000",
"parent_org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"type": 1,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Returns a list of sub organizations (as well as the parent organization)
corresponding to the given id or short name. Each item in the list will contain
the org id, org name, and org short name.
Results are in alphabetical order by org name.
Which page of results to start on
Use the AdminApi Authenticate method to get the access_token
List of organizations
Entity not found
Validation exception
GET /api/v1/AdminApi/GetOrganizations HTTP/1.1
Host: www.nexportcampus.com
Accept: */*
[
{
"org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Use the AdminApi Authenticate method to get the access_token
Model used for Request
The User Id
00000000-0000-0000-0000-000000000000The Group Id
00000000-0000-0000-0000-000000000000The Permission. From PermissionAttribute on Role Properties.
Is Permitted
Not authorized to view groups
Entity not found
Validation exception. See response body for more info.
POST /api/v1/AdminApi/HasGroupPermission HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"user_id": "00000000-0000-0000-0000-000000000000",
"group_id": "00000000-0000-0000-0000-000000000000",
"permission": "text"
}{
"is_permitted": true,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}Use the AdminApi Authenticate method to get the access_token
The Request object used for AdminApiController.SearchGroupsForPermission
The User Id
00000000-0000-0000-0000-000000000000The Organization Id to look for permissions under.
00000000-0000-0000-0000-000000000000The Permission Attribute Name Value from the Role class
The page to return
The number of items per page
List of organizations and groups
Not authorized to search for groups
Validation exception. See response body for more info.
POST /api/v1/AdminApi/SearchGroupsForPermission HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"user_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"permission": "text",
"page": 1,
"per_page": 1
}{
"groups": [
{
"id": "00000000-0000-0000-0000-000000000000",
"parent_org_id": "00000000-0000-0000-0000-000000000000",
"name": "text",
"short_name": "text",
"type": 1,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
],
"page": 1,
"page_size": 1,
"total_count": 1,
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}