AdminApi | NexPort User Documentation

Used to retrieve an authentication token for NexPort API Requests.

post

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.

Body

Contains information for obtaining an authentication token

usernamestringRequired

Username for user requesting token

passwordstringRequired

Password for user requesting token

grant_typestringRequired

Only "password" is supported currently

scopestringOptional

Scope of the access request

utc_expiration_datestring · date-timeOptional

Optional expiration date for the token (set to null for no expiration)

Responses

200

Authentication Token Information

Should conform to RFC 6750 Section 4 https://tools.ietf.org/html/rfc6750#section-4 and https://tools.ietf.org/html/rfc6749#section-4.2.2 If the resource owner grants the access request, the authorization server issues an access token and delivers it to the client by adding the following parameters to the fragment component of the redirection URI using the "application/x-www-form-urlencoded" format, per Appendix B:

access_tokenstring · uuidRequired

REQUIRED. The access token issued by the authorization server.

Example: 00000000-0000-0000-0000-000000000000

token_typestringRequired

REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive.

expires_ininteger · int32Optional

RECOMMENDED. The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value. This field will be excluded from the response if the client provides a specific expiration date in the request.

403

Unable to authenticate

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/Authenticate

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": "2026-03-02T22:54:08.514Z"
}

{
  "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.

get

Query parameters

access_tokenstring · uuidRequired

Responses

200

Validation results

Contains token expiration date or error message if the token is expired or invalid

utc_expiration_datestring · date-timeOptional

When the token expires or null if it is already expired or invalid (or if the token never expires, in which case ErrorMessage will also be empty)

error_messagestringOptional

Message describing why the token cannot be used, if applicable

422

Validation exception. See response body for more info.

get

/api/v1/AdminApi/ValidateAccessToken

GET /api/v1/AdminApi/ValidateAccessToken?access_token=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "utc_expiration_date": "2026-03-02T22:54:08.514Z",
  "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.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for creating a new user

owner_org_idstring · uuidRequired

Id of the user's owner organization

Example: 00000000-0000-0000-0000-000000000000

loginstringRequired

The login for this account

passwordstringRequired

The password for this account

first_namestringRequired

First name of the user

middle_namestringOptional

Middle name of the user

last_namestringRequired

Last name of the user

emailstringOptional

Email address of the user

titlestringOptional

User's title prefix

nicknamestringOptional

User's nickname

Responses

200

Id of created user

Contains the id of the user created by the CreateUser web api method

user_idstring · uuidRequired

Id of the created user

Example: 00000000-0000-0000-0000-000000000000

403

Not authorized to create a user

409

Entity not found or duplicate login

422

Validation exception

post

/api/v1/AdminApi/CreateUser

POST /api/v1/AdminApi/CreateUser?access_token=text 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.

get

Query parameters

loginstringOptional

Login of the user to get

user_idstring · uuidOptional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

User information

Contains user information

user_idstring · uuidRequired

Id of the user

Example: 00000000-0000-0000-0000-000000000000

owner_org_idstring · uuidOptional

Id of the user's owner organization

Example: 00000000-0000-0000-0000-000000000000

owner_org_short_namestringOptional

Short name of the user's owner organization

last_namestringRequired

Last name of the user

middle_namestringOptional

Middle name of the user

first_namestringRequired

First name of the user

emailstringOptional

Email address of the user

internal-emailstringOptional

Email address used for internal communications within NexPort Campus

titlestringOptional

User's title prefix

nicknamestringOptional

User's nickname

owner_org_namestringOptional

Full name of the owner org

403

Not authorized to view users

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetUser

GET /api/v1/AdminApi/GetUser?access_token=text 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.

get

Query parameters

loginstringRequired

User's nexport username

passwordstringRequired

User's password

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

User information

Contains user information

user_idstring · uuidRequired

Id of the user

Example: 00000000-0000-0000-0000-000000000000

owner_org_idstring · uuidOptional

Id of the user's owner organization

Example: 00000000-0000-0000-0000-000000000000

owner_org_short_namestringOptional

Short name of the user's owner organization

last_namestringRequired

Last name of the user

middle_namestringOptional

Middle name of the user

first_namestringRequired

First name of the user

emailstringOptional

Email address of the user

internal-emailstringOptional

Email address used for internal communications within NexPort Campus

titlestringOptional

User's title prefix

nicknamestringOptional

User's nickname

owner_org_namestringOptional

Full name of the owner org

403

Not authorized to view users

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/AuthenticateUser

GET /api/v1/AdminApi/AuthenticateUser?login=text&password=text&access_token=text 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.

get

Query parameters

search_termstringOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of users

Contains user information

user_idstring · uuidRequired

Id of the user

Example: 00000000-0000-0000-0000-000000000000

owner_org_idstring · uuidOptional

Id of the user's owner organization

Example: 00000000-0000-0000-0000-000000000000

owner_org_short_namestringOptional

Short name of the user's owner organization

last_namestringRequired

Last name of the user

middle_namestringOptional

Middle name of the user

first_namestringRequired

First name of the user

emailstringOptional

Email address of the user

internal-emailstringOptional

Email address used for internal communications within NexPort Campus

titlestringOptional

User's title prefix

nicknamestringOptional

User's nickname

owner_org_namestringOptional

Full name of the owner org

403

Not authorized to view users

422

Validation exception. See response body for more info.

get

/api/v1/AdminApi/GetUsers

GET /api/v1/AdminApi/GetUsers?access_token=text 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.

get

Query parameters

user_idstring · uuidOptional

loginstringOptional

Login of the user to get the contact information for

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

Address and contact information

Inherits all fields from UserContactInfoBase, used in GetUserContactInfo api method.

user_idstring · uuidRequired

Id of the user this contact information belongs to

Example: 00000000-0000-0000-0000-000000000000

address_line_1stringOptional

First line of user's address

address_line_2stringOptional

Second line of user's address

citystringOptional

User's city

statestringOptional

User's state

countrystringOptional

User's country

postal_codestringOptional

User's postal code

phonestringOptional

User's phone number

mobilestringOptional

User's mobile phone number

faxstringOptional

User's fax number

captionstringOptional

Caption

403

Not authorized to view user contact information

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetUserContactInformation

GET /api/v1/AdminApi/GetUserContactInformation?access_token=text 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.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

namestringRequired

The name of the new group

short_namestringRequired

Short name must be unique within the system...if any other groups have the same group name then an error will be thrown

billing_codestringRequired

Any string value that can be used for tracking groups later

descriptionstringRequired

Description of the group

parent_idstring · uuidRequired

ID of the group or organization that this new group will be created under.

Example: 00000000-0000-0000-0000-000000000000

Responses

200

Id of created group

group_idstring · uuidRequiredExample: 00000000-0000-0000-0000-000000000000

403

Not authorized to create a group in the given parent

409

Entity not found or duplicate login

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/CreateGroup

POST /api/v1/AdminApi/CreateGroup?access_token=text 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.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Create membership request object

groupsstring · uuid[]Required

The the groups to give the user a membership in

user_idstring · uuidRequired

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.

Example: 00000000-0000-0000-0000-000000000000

Responses

200

Memberships were successfully created

Create membership response object

403

Not authorized to add memberships to the given group

409

Entity not found or duplicate login

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/CreateMembership

POST /api/v1/AdminApi/CreateMembership?access_token=text 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.

post

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.

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Remove membership request object

groupsstring · uuid[]Optional

The list of membership group Ids to be removed

user_idstring · uuidOptional

The user Id that will be used to remove the group membership(s)

Example: 00000000-0000-0000-0000-000000000000

membershipsstring · uuid[]Optional

The list of membership Ids to be removed

Responses

200

Memberships were successfully removed

Remove membership response object

403

Not authorized to remove memberships from the given group

409

Entity not found or duplicate login

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/RemoveMembership

POST /api/v1/AdminApi/RemoveMembership?access_token=text 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

post

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.

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for editing a user's profile

user_idstring · uuidOptional

Id of the user whose information is being edited. Use either this OR login.

Example: 00000000-0000-0000-0000-000000000000

loginstringOptional

Login of the user whose information is being edited. User either this OR user_id.

first_namestringOptional

First name of the user

middle_namestringOptional

Middle name of the user

last_namestringOptional

Last name of the user

emailstringOptional

User's email address

titlestringOptional

User's title prefix

nicknamestringOptional

User's nickname

Responses

200

Edited user information

Contains information about the edited user

user_idstring · uuidRequired

Id of the edited user

Example: 00000000-0000-0000-0000-000000000000

403

Not authorized to view/edit users

409

Entity not found

422

Validation exception

post

/api/v1/AdminApi/EditUser

POST /api/v1/AdminApi/EditUser?access_token=text 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.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for creating a new subscription

org_idstring · uuidRequired

Id of the subscription's organization

Example: 00000000-0000-0000-0000-000000000000

user_idstring · uuidRequired

The user id to create the subscription for

Example: 00000000-0000-0000-0000-000000000000

Responses

200

Id of created subscription

Contains the id of the enrollment created by the CreateEnrollment web api method

subscription_idstring · uuidRequired

Id of the created subscription

Example: 00000000-0000-0000-0000-000000000000

403

Not authorized to create a subscription

409

Entity not found or duplicate subscription

422

Validation exception

post

/api/v1/AdminApi/CreateSubscription

POST /api/v1/AdminApi/CreateSubscription?access_token=text 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.

get

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.

Query parameters

user_idstring · uuidOptional

org_short_namestringOptional

org_idstring · uuidOptional

subscription_idstring · uuidOptional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

Subscription information

Contains relevant details about a user subscription

subscription_idstring · uuidRequired

Id of the subscription

Example: 00000000-0000-0000-0000-000000000000

user_idstring · uuidRequired

Id of the user this subscription belongs to

Example: 00000000-0000-0000-0000-000000000000

org_idstring · uuidRequired

Id of the organization this subscription belongs to

Example: 00000000-0000-0000-0000-000000000000

org_namestringOptional

Name of the organization this subscription belongs to

org_shortnamestringOptional

Short name of the organization this subscription belongs to

utc_date_createdstring · date-timeRequired

When this subscription was created

utc_date_updatedstring · date-timeOptional

When this subscription was last updated

billing_codestringRequired

The billing code for this subscription

utc_expiration_datestring · date-timeRequired

When this subscription expires

is_disabledbooleanRequired

True if disabled, false if not disabled

403

Not authorized to view subscriptions

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetSubscription

GET /api/v1/AdminApi/GetSubscription?access_token=text 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": "2026-03-02T22:54:08.514Z",
  "utc_date_updated": "2026-03-02T22:54:08.514Z",
  "billing_code": "text",
  "utc_expiration_date": "2026-03-02T22:54:08.514Z",
  "is_disabled": true,
  "subscription_status": {
    "current_status_name": "text",
    "previous_status_name": "text",
    "status_date_set": "2026-03-02T22:54:08.514Z"
  },
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Deprecated

Get subscription information for a user or an organization.

get

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.

Query parameters

user_idstring · uuidOptional

loginstringOptional

Login of the user to get subscriptions for

org_idstring · uuidOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of subscriptions

Contains relevant details about a user subscription

subscription_idstring · uuidRequired

Id of the subscription

Example: 00000000-0000-0000-0000-000000000000

user_idstring · uuidRequired

Id of the user this subscription belongs to

Example: 00000000-0000-0000-0000-000000000000

org_idstring · uuidRequired

Id of the organization this subscription belongs to

Example: 00000000-0000-0000-0000-000000000000

org_namestringOptional

Name of the organization this subscription belongs to

org_shortnamestringOptional

Short name of the organization this subscription belongs to

utc_date_createdstring · date-timeRequired

When this subscription was created

utc_date_updatedstring · date-timeOptional

When this subscription was last updated

billing_codestringRequired

The billing code for this subscription

utc_expiration_datestring · date-timeRequired

When this subscription expires

is_disabledbooleanRequired

True if disabled, false if not disabled

403

Not authorized to view subscriptions

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetSubscriptions

GET /api/v1/AdminApi/GetSubscriptions?access_token=text 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": "2026-03-02T22:54:08.514Z",
    "utc_date_updated": "2026-03-02T22:54:08.514Z",
    "billing_code": "text",
    "utc_expiration_date": "2026-03-02T22:54:08.514Z",
    "is_disabled": true,
    "subscription_status": {
      "current_status_name": "text",
      "previous_status_name": "text",
      "status_date_set": "2026-03-02T22:54:08.514Z"
    },
    "api_error_entity": {
      "error_code": 0,
      "error_message": "text",
      "warning_messages": [
        "text"
      ]
    }
  }
]

Search subscription information for a user or an organization.

post

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.

Query parameters

pageinteger · int32Optional

The request page of results

per_pageinteger · int32Optional

Number of results to return on each page

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

user_idsstring · uuid[]Optional

Limit the results to only subscriptions for these users

org_idsstring · uuid[]Optional

Limit the results to only subscriptions to these organizations

utc_expires_beforestring · date-timeOptional

Only return subscriptions expiring before this date

utc_expires_afterstring · date-timeOptional

Only return subscriptions expiring after this date

utc_create_beforestring · date-timeOptional

Only return subscriptions createa before this date

utc_create_afterstring · date-timeOptional

Only return subscriptions created AFTER this date

Responses

200

Subscription search results successfully returned

Results of a subscription search call

pageinteger · int32Required

The one based index of the current page

page_sizeinteger · int32Required

Requested page size

total_countinteger · int32Required

Number of records across ALL pages

403

Not authorized to view subscriptions

409

Entity not found

422

Validation exception

post

/api/v1/AdminApi/SearchSubscriptions

POST /api/v1/AdminApi/SearchSubscriptions?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 386

{
  "user_ids": [
    "06e4b02e-f004-4acb-81d9-076c01b55f85",
    "e32a18a4-bd6a-4b8c-8883-b20afe14fd28"
  ],
  "org_ids": [
    "ed1e8859-5c87-4e09-a901-2c34ec5a9ae9",
    "50c70f8a-62b6-4a4d-ac1f-6db46e09b19d"
  ],
  "utc_expires_before": "2026-03-02T21:53:01.6163977Z",
  "utc_expires_after": "2028-03-02T21:53:01.6163977Z",
  "utc_create_before": "2026-03-01T21:53:01.6163977Z",
  "utc_create_after": "2026-02-10T21:53:01.6163977Z"
}

{
  "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.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains information for enabling or disabling a subscription

subscription_idstring · uuidRequired

Id of the subscription to enable or disable

Example: 00000000-0000-0000-0000-000000000000

disablebooleanOptional

Enable or disable this subscription. Setting this to false enables the subscription. Setting it to true will disable it.

Responses

200

Whether the subscription is disabled after the method call

Contains information about the subscription that was enabled/disabled. You can use this to verify that the call to DisableSubscription had the intended effect on the subscription if no errors are thrown.

subscription_idstring · uuidRequired

Id of the subscription that was enabled/disabled

Example: 00000000-0000-0000-0000-000000000000

disabledbooleanRequired

True if subscription is disabled, false otherwise

403

Not authorized to update subscriptions

409

Entity not found

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/DisableSubscription

POST /api/v1/AdminApi/DisableSubscription?access_token=text 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 on the Subscription.

post

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.

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

subscription_idstring · uuidRequired

The Subscription Id

Example: 00000000-0000-0000-0000-000000000000

subscription_statusstringRequired

The status that should be set on this subscription. Use empty string to set the subscription status to the default subscription status.

Responses

200

Subscription Id, Current Subscription Status, Previous Subscription Status, and the date the new Subscription Status was set

subscription_idstring · uuidRequired

Id of the Subscription

Example: 00000000-0000-0000-0000-000000000000

current_subscription_statusstringRequired

The current subscription status

previous_scubscription_statusstringRequired

The previous subscription status

status_date_setstring · date-timeRequired

The datetime the status was last changed

403

Not authorized to update subscriptions

409

Subscription or Subscription Status not found

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/SetSubscriptionStatus

POST /api/v1/AdminApi/SetSubscriptionStatus?access_token=text 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": "2026-03-02T22:54:08.514Z",
  "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.

get

Will throw a CustomFieldNotFound exception if no custom profile field exists with the given field id.

Query parameters

org_idstring · uuidRequired

field_idstring · uuidOptional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of custom profile fields

Contains information for a single custom profile field

field_idstring · uuidRequired

Id of the custom profile field

Example: 00000000-0000-0000-0000-000000000000

namestringRequired

Represents the name of the custom profile field

keystringRequired

Key of the custom profile field

descriptionstringRequired

Description of the custom profile field

typeinteger · enumRequired

Type of custom profile field. None=0; Text=1; DateTime=2; Boolean=3; Numeric=4; Email=5; SelectDropDown=6; DateOnly=7; SelectCheckbox=8;0 = None, 1 = Text Field, 2 = Date/Time Field, 3 = YES/NO Field, 4 = Number Field, 5 = Email Field, 6 = Select Dropdown Field, 7 = Date Field, 8 = Select Checkbox Field

Possible values:

org_idstring · uuidRequired

Id of the organization this custom profile field belongs to

Example: 00000000-0000-0000-0000-000000000000

org_short_namestringRequired

Short name of the organization this custom profile field belongs to

409

Entity not found

422

Validation exception. See response body for more info.

get

/api/v1/AdminApi/GetCustomProfileFields

GET /api/v1/AdminApi/GetCustomProfileFields?org_id=123e4567-e89b-12d3-a456-426614174000&access_token=text 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.

get

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.

Query parameters

subscriber_idstring · uuidOptional

user_idstring · uuidOptional

org_idstring · uuidOptional

keystringOptional

Key of the custom profile field to get the value for

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of custom profile field values

Contains information for a single custom profile field value

namestringRequired

Represents the name of the custom field

keystringRequired

Key of the custom field

valuestringRequired

Custom field value

org_idstring · uuidRequired

Id of the subscription organization this custom profile field value belongs to

Example: 00000000-0000-0000-0000-000000000000

org_short_namestringRequired

Short name of the subscription organization this custom profile field value belongs to

field_idstring · uuidRequired

Id of the field this custom profile field value corresponds to

Example: 00000000-0000-0000-0000-000000000000

typeinteger · enumRequired

Type of custom profile field this value belongs to. None=0; Text=1; DateTime=2; Boolean=3; Numeric=4; Email=5; SelectDropDown=6; DateOnly=7; SelectCheckbox=8;0 = None, 1 = Text Field, 2 = Date/Time Field, 3 = YES/NO Field, 4 = Number Field, 5 = Email Field, 6 = Select Dropdown Field, 7 = Date Field, 8 = Select Checkbox Field

Possible values:

utc_date_modifiedstring · date-timeRequired

Date/Time that the value was last modified

403

Not authorized to view user profiles

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetCustomProfileFieldValues

GET /api/v1/AdminApi/GetCustomProfileFieldValues?access_token=text 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": "2026-03-02T22:54:08.514Z",
    "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.

post

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.

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains id of the subscription and the custom fields/values to set

subscriber_idstring · uuidRequired

Id of the subscription to set the custom values for

Example: 00000000-0000-0000-0000-000000000000

Responses

200

Error information

Used to inform the method caller if any of the passed in fields are invalid. Message may contain additional error information.

messagestringOptional

Contains additional information about the type of error that occurred

403

Not authorized to edit profiles

409

Entity not found

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/SetCustomProfileFieldValues

POST /api/v1/AdminApi/SetCustomProfileFieldValues?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "subscriber_id": "df186af2-144e-475a-ad01-9e9f42090ec6",
  "subscriber_pair": {
    "user_id": "e556a4f0-2994-4fb5-bdb3-11c342808170",
    "org_id": "66655443-7244-40ac-be68-8b693370709b"
  },
  "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.

get

Query parameters

search_operatorinteger · enumRequired

0 = Disjunction, 1 = Conjunction

Possible values:

base_org_idstring · uuidRequired

namestringOptional

The organization/group name

short_namestringOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of organizations and groups

Contains organization/group name, short name

idstring · uuidRequired

Id of an organization or a group

Example: 00000000-0000-0000-0000-000000000000

parent_org_idstring · uuidRequired

Id of the parent organization (if existed)

Example: 00000000-0000-0000-0000-000000000000

namestringRequired

Name of the organization or the group

short_namestringRequired

Short name of the organization or the group

typeinteger · int32Optional

Type of the directory, either an organization or a group

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/SearchDirectory

GET /api/v1/AdminApi/SearchDirectory?search_operator=0&base_org_id=123e4567-e89b-12d3-a456-426614174000&access_token=text 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.

get

Query parameters

org_idstring · uuidOptional

org_short_namestringOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of organizations

Contains organization name, short name, and custom fields

org_idstring · uuidRequired

Id of the organization

Example: 00000000-0000-0000-0000-000000000000

namestringRequired

Name of the organization

short_namestringRequired

Short name of the organization

409

Entity not found

422

Validation exception

get

/api/v1/AdminApi/GetOrganizations

GET /api/v1/AdminApi/GetOrganizations?access_token=text 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"
      ]
    }
  }
]

Checks if the given user has permission on a group.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Model used for Request

user_idstring · uuidRequired

The User Id

Example: 00000000-0000-0000-0000-000000000000

group_idstring · uuidRequired

The Group Id

Example: 00000000-0000-0000-0000-000000000000

permissionstringRequired

The Permission. From PermissionAttribute on Role Properties.

Responses

200

Is Permitted

is_permittedbooleanRequired

403

Not authorized to view groups

409

Entity not found

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/HasGroupPermission

POST /api/v1/AdminApi/HasGroupPermission?access_token=text 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"
    ]
  }
}

Searches for groups on which the given user has permission.

post

Query parameters

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

The Request object used for AdminApiController.SearchGroupsForPermission

user_idstring · uuidRequired

The User Id

Example: 00000000-0000-0000-0000-000000000000

org_idstring · uuidRequired

The Organization Id to look for permissions under.

Example: 00000000-0000-0000-0000-000000000000

permissionstringRequired

The Permission Attribute Name Value from the Role class

pageinteger · int32Optional

The page to return

per_pageinteger · int32Optional

The number of items per page

Responses

200

List of organizations and groups

The Request object used for AdminApiController.SearchGroupsForPermission

pageinteger · int32Required

The one based index of the current page

page_sizeinteger · int32Required

Requested page size

total_countinteger · int32Required

Number of records across ALL pages

403

Not authorized to search for groups

422

Validation exception. See response body for more info.

post

/api/v1/AdminApi/SearchGroupsForPermission

POST /api/v1/AdminApi/SearchGroupsForPermission?access_token=text 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"
    ]
  }
}

hashtagUsed to retrieve an authentication token for NexPort API Requests.

hashtagUsed 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.

hashtagCreates a user with the information specified by request. Requires the Create Users permission in the specified owner org or any ancestors.

hashtagGets 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.

hashtagValidates 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.

hashtagCreates a group under the given parent group or organization. Requires the AddGroup permission in the specified parent or one of it's ancestors.

hashtagCreates 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.

hashtagRemove memberships in each of the given groups. This call is atomic. If one membership removal fails then they will all fail.

hashtagEdits user information

hashtagCreates a subscription with the information specified by request. Requires the Add Subscriptions permission.

hashtagGets subscription information for the user in the organization.

hashtagGet subscription information for a user or an organization.

hashtagSearch subscription information for a user or an organization.

hashtagEnables or disables a subscription. Requires the Update Subscriptions permission in the subscription organization or an ancestor.

hashtagSets the Subscription Status on the Subscription.

hashtagGets all the custom profile fields available to an organization, or a field matching an id in a given org.

hashtagGets the custom profile field values based on the given criteria, with DateTime fields being in UTC.

hashtagSets the custom profile field values for a subscription based on the subscriber id and key/value pairs in the request.

hashtagReturns 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.

hashtagReturns 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.

hashtagChecks if the given user has permission on a group.

hashtagSearches for groups on which the given user has permission.

Used to retrieve an authentication token for NexPort API Requests.

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.

Creates a user with the information specified by request. Requires the Create Users permission in the specified owner org or any ancestors.

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.

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.

Creates a group under the given parent group or organization. Requires the AddGroup permission in the specified parent or one of it's ancestors.

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.

Remove memberships in each of the given groups. This call is atomic. If one membership removal fails then they will all fail.

Edits user information

Creates a subscription with the information specified by request. Requires the Add Subscriptions permission.

Gets subscription information for the user in the organization.

Get subscription information for a user or an organization.

Search subscription information for a user or an organization.

Enables or disables a subscription. Requires the Update Subscriptions permission in the subscription organization or an ancestor.

Sets the Subscription Status on the Subscription.

Gets all the custom profile fields available to an organization, or a field matching an id in a given org.

Gets the custom profile field values based on the given criteria, with DateTime fields being in UTC.

Sets the custom profile field values for a subscription based on the subscriber id and key/value pairs in the request.

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.

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.

Checks if the given user has permission on a group.

Searches for groups on which the given user has permission.