API docs by Redocly

Registration (1.0.0)

Download OpenAPI specification:Download

E-mail: support@myturn.com

An API for creating myTurn user accounts. This is intended to be used as part of a self registration process.

Public

No authentication required

Log in to get initial access token.

Request Body schema:
username
required
string

The user's myTurn.com username, or their membership ID with their organization/tool library.

password
required
string

The user's myTurn.com password.

Responses

Request samples

Content type
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "displayName": "string",
  • "emailAddress": "string",
  • "expires_in": 0,
  • "token_type": "Bearer",
  • "access_token": "string",
  • "roles": [
    ],
  • "isAdmin": true,
  • "membership": {
    },
  • "organizations": [
    ]
}

Log in to get initial access token.

Request Body schema:
username
required
string

The user's myTurn.com username, or their membership ID with their organization/tool library.

password
required
string

The user's myTurn.com password.

Responses

Request samples

Content type
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "displayName": "string",
  • "emailAddress": "string",
  • "expires_in": 0,
  • "token_type": "Bearer",
  • "access_token": "string",
  • "roles": [
    ],
  • "isAdmin": true,
  • "membership": {
    },
  • "organizations": [
    ]
}

Obtain a list of fields to be collected during user registration.

Lists all the fields the organization has configured to be requested or required for users to sign up during the registration process.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verify is a username is valid and available

Check the username against username rules, and make sure the name is available. Usernames are unique across all myTurn sites.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
username
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Receive suggestions for available usernames.

Try various way of mixing last name, first name and desired username, and add digits if necessary to find a unique username. Suggests up to 3 options.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
lastName
string
firstName
string
username
string

Responses

Request samples

Content type
application/json
{
  • "lastName": "Tables",
  • "firstName": "Bobby",
  • "username": "littleBobbytables"
}

Response samples

Content type
application/json
{
  • "usernames": [
    ]
}

Verify if a membership ID is available.

Check to make sure the membership ID is not already taken by another user at this organization.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
membershipId
required
string

Responses

Request samples

Content type
application/json
{
  • "membershipId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Verify is a username can be used

Make sure the email address is not already taken by another user at this organization, and that the email address is well formed.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Verify if a password can be used

Check the password against password rules.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Suggest a strong password.

Generate a string random password. The password generated is not used for the account automatically. This is useful when generating accounts as an administrator and to provide a strong suggested password to the user.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
{
  • "password": "XKRBK0DpPlWR5UElD6w"
}

Verify individual fields in a single call

Validate username, email address, Membership ID, password, or any combination of these, in a single call.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
username
string
password
string
emailAddress
string
membershipId
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "emailAddress": "string",
  • "membershipId": "string"
}

Response samples

Content type
application/json
Example
{
  • "validationSuccessful": false,
  • "details": {
    }
}

Return a list of membership types the user can select.

List memberships that can be chosen for the account. The memberships listed are only those that are configured as "may be self-purchased" and that have no cost. We will support purchasing memberships via the API in the future.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of agreements required at signup.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the details of an agreement.

query Parameters
id
required
integer
header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
{
  • "id": 632,
  • "title": "Terms and Conditions",
  • "text": "string"
}

Provide the registration information and create a new user.

Creates the user, and logs the user in. The parameters listed as required (below) are always required; other parameters are required if /api/v1.1/registration/fields says they are required. Additionally, any field returned by /api/v1.1/registration/fields is also accepted here, and may be required.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
lastName
required
string

User's last name

firstName
required
string

User's first name

title
string

Dr, Mr, Ms, etc.

organizationName
string
department
string
emailAddress
required
string
membershipId
string
username
required
string
password
required
string
sex
string
dateOfBirth
string
address.street1
string
address.street2
string
address.city
string
address.country
string

The code for the user's country. Use /api/v1.1/countries endpoint to get the list of valid options.

address.principalSubdivision
string

The short code for the state or province and must be valid the for country. Use /api/v1.1/countries/$countryCode/principalSubdivisions for valid list.

address.postalCode
string
address.phone
string
address.phone2
string
address.notes
string

Responses

Request samples

Content type
application/json
{
  • "lastName": "string",
  • "firstName": "string",
  • "title": "string",
  • "organizationName": "string",
  • "department": "string",
  • "emailAddress": "string",
  • "membershipId": "string",
  • "username": "string",
  • "password": "string",
  • "sex": "string",
  • "dateOfBirth": "string",
  • "address.street1": "string",
  • "address.street2": "string",
  • "address.city": "string",
  • "address.country": "CAN",
  • "address.principalSubdivision": "NY",
  • "address.postalCode": "string",
  • "address.phone": "string",
  • "address.phone2": "string",
  • "address.notes": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "displayName": "string",
  • "emailAddress": "string",
  • "expires_in": 0,
  • "token_type": "Bearer",
  • "access_token": "string",
  • "roles": [
    ],
  • "isAdmin": true,
  • "membership": {
    },
  • "organizations": [
    ]
}

Testing

Only on test

Obtain a list of fields to be collected during user registration.

Lists all the fields the organization has configured to be requested or required for users to sign up during the registration process.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verify is a username is valid and available

Check the username against username rules, and make sure the name is available. Usernames are unique across all myTurn sites.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
username
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Receive suggestions for available usernames.

Try various way of mixing last name, first name and desired username, and add digits if necessary to find a unique username. Suggests up to 3 options.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
lastName
string
firstName
string
username
string

Responses

Request samples

Content type
application/json
{
  • "lastName": "Tables",
  • "firstName": "Bobby",
  • "username": "littleBobbytables"
}

Response samples

Content type
application/json
{
  • "usernames": [
    ]
}

Verify if a membership ID is available.

Check to make sure the membership ID is not already taken by another user at this organization.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
membershipId
required
string

Responses

Request samples

Content type
application/json
{
  • "membershipId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Verify is a username can be used

Make sure the email address is not already taken by another user at this organization, and that the email address is well formed.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Verify if a password can be used

Check the password against password rules.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "validationSuccessful": true,
  • "details": {
    }
}

Suggest a strong password.

Generate a string random password. The password generated is not used for the account automatically. This is useful when generating accounts as an administrator and to provide a strong suggested password to the user.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
{
  • "password": "XKRBK0DpPlWR5UElD6w"
}

Verify individual fields in a single call

Validate username, email address, Membership ID, password, or any combination of these, in a single call.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/json
username
string
password
string
emailAddress
string
membershipId
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "emailAddress": "string",
  • "membershipId": "string"
}

Response samples

Content type
application/json
Example
{
  • "validationSuccessful": false,
  • "details": {
    }
}

List of agreements required at signup.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the details of an agreement.

query Parameters
id
required
integer
header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
{
  • "id": 632,
  • "title": "Terms and Conditions",
  • "text": "string"
}

Planned

Not implemented yet

Return a list of membership types the user can select.

List memberships that can be chosen for the account. The memberships listed are only those that are configured as "may be self-purchased" and that have no cost. We will support purchasing memberships via the API in the future.

header Parameters
Accept-Language
string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]