Authentication (1.1-oas3)

Download OpenAPI specification:Download

API calls to authenticate the user. These calls are also included in other API documentation for convenience.

Public

Operations that can be called without logging in

Log in to get initial access token.

Request Body schema:
application/json

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

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"username": "string",
"lastName": "string",
"firstName": "string",
"displayName": "string",
"emailAddress": "string",
"expires_in": 0,
"token_type": "Bearer",
"access_token": "string",
"roles": ["string"
],
"isAdmin": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
},
"organizations": [{"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
]
}

Refresh the access token. Deprecated

Request Body schema:
application/x-www-form-urlencoded
required

grant_type required	string Value: "refresh_token" Must always be "refresh_token".
refresh_token required	string The refresh token issued to the client during a previous login or refresh.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

No sample

Response samples

200
400

Content type

application/json

{"username": "string",
"lastName": "string",
"firstName": "string",
"displayName": "string",
"emailAddress": "string",
"expires_in": 0,
"token_type": "Bearer",
"access_token": "string",
"roles": ["string"
],
"isAdmin": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
},
"organizations": [{"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
]
}

Send an email with a link to reset password to the user who this email address belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema:
application/json

email

required

string

The user's email address

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/forgotPasswordByEmail

Local deploy (Nancy - 1)

https://demo.luisa.myturn.com:8441/library/api/v1.1/forgotPasswordByEmail

Local deploy (Nancy - 4)

https://demo.luisa.myturn.com:8444/library/api/v1.1/forgotPasswordByEmail

Test

https://demo.test.myturn.com/library/api/v1.1/forgotPasswordByEmail

Production

https://demo.myturn.com/library/api/v1.1/forgotPasswordByEmail

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200
400

Content type

application/json

"If a matching account exists, we will send a password reset to the address on file."

Send an email with a link to reset password to the user who this username belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema:
application/json

email

string

The user's myTurn.com username

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/forgotPasswordByUsername

Local deploy (Nancy - 1)

https://demo.luisa.myturn.com:8441/library/api/v1.1/forgotPasswordByUsername

Local deploy (Nancy - 4)

https://demo.luisa.myturn.com:8444/library/api/v1.1/forgotPasswordByUsername

Test

https://demo.test.myturn.com/library/api/v1.1/forgotPasswordByUsername

Production

https://demo.myturn.com/library/api/v1.1/forgotPasswordByUsername

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200
400

Content type

application/json

"OK"

Send an email with a link to reset password to the user who this member id belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema:
application/json

membersId

string

The user's member id within this organization

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/forgotPasswordByMemberId

Local deploy (Nancy - 1)

https://demo.luisa.myturn.com:8441/library/api/v1.1/forgotPasswordByMemberId

Local deploy (Nancy - 4)

https://demo.luisa.myturn.com:8444/library/api/v1.1/forgotPasswordByMemberId

Test

https://demo.test.myturn.com/library/api/v1.1/forgotPasswordByMemberId

Production

https://demo.myturn.com/library/api/v1.1/forgotPasswordByMemberId

Request samples

Payload

Content type

application/json

{"membersId": "string"
}

Response samples

200
400

Content type

application/json

"OK"

User

Operations available to registered users who are logged in

Details about the current user.

Responses

Response samples

200
451

Content type

application/json

{"username": "string",
"lastName": "string",
"firstName": "string",
"displayName": "string",
"emailAddress": "string",
"expires_in": 0,
"token_type": "Bearer",
"access_token": "string",
"roles": ["string"
],
"isAdmin": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
},
"organizations": [{"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
]
}

Log the user out of the system.

Responses

Log the user out of the system. Deprecated

Responses

Details about the current user.

Responses

Response samples

200
451

Content type

application/json

{"username": "string",
"lastName": "string",
"firstName": "string",
"displayName": "string",
"emailAddress": "string",
"expires_in": 0,
"token_type": "Bearer",
"access_token": "string",
"roles": ["string"
],
"isAdmin": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
},
"organizations": [{"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
]
}

Lists which organizations the user belongs to, and describes the membership.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/my-organizations

Local deploy (Nancy - 1)

https://demo.luisa.myturn.com:8441/library/api/v1.1/my-organizations

Local deploy (Nancy - 4)

https://demo.luisa.myturn.com:8444/library/api/v1.1/my-organizations

Test

https://demo.test.myturn.com/library/api/v1.1/my-organizations

Production

https://demo.myturn.com/library/api/v1.1/my-organizations

Response samples

200
451

Content type

application/json

[{"organization": {"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
}
]

Authentication (1.1-oas3)

Public

Log in to get initial access token.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json

Responses

Request samples

Response samples

Refresh the access token. Deprecated

Request Body schema: application/x-www-form-urlencodedapplication/jsonapplication/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Send an email with a link to reset password to the user who this email address belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json

Responses

Request samples

Response samples

Send an email with a link to reset password to the user who this username belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json

Responses

Request samples

Response samples

Send an email with a link to reset password to the user who this member id belongs to, if such a user exists in this organization. If no such user exists, the answer is the same as if the user exists.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json

Responses

Request samples

Response samples

User

Details about the current user.

Responses

Response samples

Log the user out of the system.

Responses

Log the user out of the system. Deprecated

Responses

Details about the current user.

Responses

Response samples

Lists which organizations the user belongs to, and describes the membership.

Responses

Response samples

Request Body schema:
application/json

Request Body schema:
application/x-www-form-urlencoded
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json