User API (1.0.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com/ License: MIT

API for Amusement Connect User Services

User

Get Roles

Retrieve all roles in the system, including their associated permission IDs.

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"roles": [{"name": "Manager",
"permissionIds": [1,
2,
3,
4,
5
]
}
]
}

Get Permissions

Retrieve all app permissions.

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"permissionGroups": [{"id": 0,
"name": "string",
"menuOrder": 0,
"permissionSets": [{"primary": {"id": 0,
"name": "string",
"description": "string",
"area": "string",
"route": "string",
"action": "string",
"isMenu": true,
"showPermission": true,
"menuOrder": 0,
"subMenuId": 0,
"subMenuName": "string",
"sortOrder": 0,
"isAdmin": true
},
"Glued": [{"id": 0,
"name": "string",
"description": "string",
"area": "string",
"route": "string",
"action": "string",
"isMenu": true,
"showPermission": true,
"menuOrder": 0,
"subMenuId": 0,
"subMenuName": "string",
"sortOrder": 0,
"isAdmin": true
}
]
}
]
}
]
}

Get Users by Location

Retrieve users that have access to a specific location, with optional filtering by role and permissions.

Authorizations:

apiKey

path Parameters

required

integer or string

The unique identifier of the location.

query Parameters

apiVersion	string Value: "1.0" The version of the API to use.
take	integer Example: take=10 The maximum number of records to return in the response. If not specified, all records are returned.
skip	integer Example: skip=10 The number of records to skip in the response. If not specified, no records are skipped.
isInRole	Array of strings Filter users by role.
search	string Text based search to filter the collection by
includeAdmins	boolean Whether to include admin users in the results.
hasAllPermissionIds	Array of integers Filter by users that have all of the specified permission IDs.
hasAnyPermissionIds	Array of integers Filter by users that have any of the specified permission IDs.

Responses

Response samples

200
400
500

Content type

application/json

{"totalCount": 0,
"data": [{"user": {"id": "string",
"name": "string",
"userName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"emailConfirmed": true,
"phoneNumberConfirmed": true,
"isDisabled": true,
"registrationDateUtc": "2019-08-24T14:15:22Z",
"birthday": "2019-08-24",
"playerTag": "string"
},
"role": "Manager"
}
]
}

Query User Location Access

Query the locations a user has access to, with optional filtering by location ID, role, and permissions.

Authorizations:

apiKey

path Parameters

userId

required

string

The unique identifier of the user.

query Parameters

apiVersion	string Value: "1.0" The version of the API to use.
	integer or string The unique identifier of the location.
hasAllPermissionIds	Array of integers Filter by users that have all of the specified permission IDs.
hasAnyPermissionIds	Array of integers Filter by users that have any of the specified permission IDs.
isInRole	Array of strings Filter users by role.
take	integer Example: take=10 The maximum number of records to return in the response. If not specified, all records are returned.
skip	integer Example: skip=10 The number of records to skip in the response. If not specified, no records are skipped.
select	Array of any Items Enum: "role" "permissions" Specify additional fields to be included in the response.

Responses

Response samples

200
400
500

Content type

application/json

{"totalCount": 0,
"data": [{"locationId": 0,
"role": "Manager",
"permissions": [1,
2,
3,
4,
5
]
}
]
}

Get user permissions for location

Retrieve the role and permissions a user has for a specific location.

Authorizations:

apiKey

path Parameters

userId required	string The unique identifier of the user.
required	integer or string The unique identifier of the location.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"locationId": 0,
"role": "Manager",
"permissions": [1,
2,
3,
4,
5
]
}

Update User Location Access

Update the role and/or permissions a user has for a specific location.

Authorizations:

apiKey

path Parameters

userId required	string The unique identifier of the user.
required	integer or string The unique identifier of the location.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

One of

role	any (roleName) Enum: "Admin" "AdminManager" "AdminEmployee" "Operator" "Co-Operator" "LocationManager" "CollectionManager" "Manager" "Employee" "Technician" "RedemptionUser" "BMI" "RedemptionLight" "Player" "Sales Group"
permissionIds required	Array of integers (permissionIds)

Responses

Request samples

Payload

Content type

application/json

{"role": "Manager",
"addPermissionIds": [1,
2,
3,
4,
5
],
"removePermissionIds": [1,
2,
3,
4,
5
]
}

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Remove User Location Access

Remove all access a user has to a specific location.

Authorizations:

apiKey

path Parameters

userId required	string The unique identifier of the user.
required	integer or string The unique identifier of the location.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Check User Location Access

Perform an authorization check to see if a user meets the requirements at a specific location.

Authorizations:

apiKey

path Parameters

userId required	string The unique identifier of the user.
required	integer or string The unique identifier of the location.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"isAuthorized": true
}

Application

Get Applications

Retrieve all applications in the system.

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"applications": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAtUtc": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"isArchived": true,
"archivedAtUtc": "2019-08-24T14:15:22Z",
"archivedBy": "string"
}
]
}

Create Application

Create a new application in the system.

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

name	string <= 128 characters
description	string or null <= 1024 characters
scopes	Array of strings[ items <= 64 characters ]
	Array of objects (claim)
createdByUserId	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"createdByUserId": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAtUtc": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"isArchived": true,
"archivedAtUtc": "2019-08-24T14:15:22Z",
"archivedBy": "string"
}

Get Application by API Key

Get an application by it's api key. Intended for internal use by other api services to validate keys.

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

apiKey

string

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAtUtc": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"isArchived": true,
"archivedAtUtc": "2019-08-24T14:15:22Z",
"archivedBy": "string"
}

Get Application by ID

Get an application by its unique identifier.

Authorizations:

apiKey

path Parameters

applicationId

required

string <uuid>

The unique identifier of the application.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"application": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAtUtc": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"isArchived": true,
"archivedAtUtc": "2019-08-24T14:15:22Z",
"archivedBy": "string"
},
"apiKeys": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keyPrefix": "string",
"key": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string"
}
]
}

Update Application

Update an application

Authorizations:

apiKey

path Parameters

applicationId

required

string <uuid>

The unique identifier of the application.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json

name	string
description	string or null
scopes	Array of strings
	Array of objects (claim)
isDisabled	boolean
isArchived	boolean
updatedByUserId	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"scopes": ["string"
],
"claims": [{"type": "string",
"value": "string"
}
],
"isDisabled": true,
"isArchived": true,
"updatedByUserId": "string"
}

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Create API Key

Generate a new API key for the application, or import a predefined key.

Authorizations:

apiKey

path Parameters

applicationId

required

string <uuid>

The unique identifier of the application.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

apiKey	string or null
createdByUserId	string or null

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "string",
"createdByUserId": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keyPrefix": "string",
"key": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Update API Key

Update the state of an existing API key.

Authorizations:

apiKey

path Parameters

applicationId required	string <uuid> The unique identifier of the application.
apiKeyId required	string <uuid> The unique identifier of the API key.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

isDisabled	boolean
updatedByUserId	string or null

Responses

Request samples

Payload

Content type

application/json

{"isDisabled": true,
"updatedByUserId": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keyPrefix": "string",
"key": "string",
"isDisabled": true,
"disabledAtUtc": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"createdAtUtc": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Get Scopes

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"scopes": ["string"
]
}

Add Scope

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

scope

string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"scope": "string"
}

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Get Current User

Authorizations:

apiKey

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"name": "string",
"userName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"emailConfirmed": true,
"phoneNumberConfirmed": true,
"isDisabled": true,
"registrationDateUtc": "2019-08-24T14:15:22Z",
"birthday": "2019-08-24",
"playerTag": "string"
}

Get User by ID

Authorizations:

apiKey

path Parameters

userId

required

string

The unique identifier of the user.

query Parameters

apiVersion

string

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"name": "string",
"userName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"emailConfirmed": true,
"phoneNumberConfirmed": true,
"isDisabled": true,
"registrationDateUtc": "2019-08-24T14:15:22Z",
"birthday": "2019-08-24",
"playerTag": "string"
}

User API (1.0.0)

User

Get Roles

Authorizations:

query Parameters

Responses

Response samples

Get Permissions

Authorizations:

query Parameters

Responses

Response samples

Get Users by Location

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Query User Location Access

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get user permissions for location

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update User Location Access

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove User Location Access

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Check User Location Access

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Application

Get Applications

Authorizations:

query Parameters

Responses

Response samples

Create Application

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Application by API Key

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Application by ID

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update Application

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required