Core Concepts
Examples
Endpoints
- Accounts
- Workspaces
- Users
- User
- Invites
- Avatar
- History
- Settings
- Authentication
Get permissions
Returns the permissions of the current user.
curl --request GET \
--url https://api.mudstack.com/users/permissions \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"auth0UserID": "<string>",
"email": "<string>",
"accounts": [
{
"id": "<string>",
"name": "<string>",
"account_tier_id": "<string>",
"thumbnail_file_id": "<string>",
"created_by_user_id": "<string>",
"defaultAvatar": 123,
"sequence": 123,
"subscription": {
"account_id": "<string>",
"stripe_customer_id": "<string>",
"status": "<string>",
"licenses": 123,
"frequency": "yearly",
"contact": "<string>"
},
"members": {
"account_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"tier": {
"id": "<string>",
"type": "personal",
"name": "<string>",
"maxStorage": 123,
"costPerLicense": 123,
"costPerExtraTB": 123
},
"type": {
"id": "<string>",
"name": "<string>",
"maxStorage": 123,
"maxAssets": 123,
"maxUsers": 123,
"costPerUser": 123,
"addStoragePrice": 123
},
"creator": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
},
"workspaces": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"defaultAvatar": 5,
"created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": "<string>",
"roles": {
"workspace_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"usage": {}
}
],
"isCreator": true,
"account_roles": [
"<string>"
]
}
],
"personalAccount": {
"id": "<string>",
"name": "<string>",
"account_tier_id": "<string>",
"thumbnail_file_id": "<string>",
"created_by_user_id": "<string>",
"defaultAvatar": 123,
"sequence": 123,
"subscription": {
"account_id": "<string>",
"stripe_customer_id": "<string>",
"status": "<string>",
"licenses": 123,
"frequency": "yearly",
"contact": "<string>"
},
"members": {
"account_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"tier": {
"id": "<string>",
"type": "personal",
"name": "<string>",
"maxStorage": 123,
"costPerLicense": 123,
"costPerExtraTB": 123
},
"type": {
"id": "<string>",
"name": "<string>",
"maxStorage": 123,
"maxAssets": 123,
"maxUsers": 123,
"costPerUser": 123,
"addStoragePrice": 123
},
"creator": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
},
"workspaces": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"defaultAvatar": 5,
"created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": "<string>",
"roles": {
"workspace_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"usage": {}
}
],
"isCreator": true,
"account_roles": [
"<string>"
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Represents an account with various properties and relationships.
Unique identifier for the account.
Name of the account.
Identifier for the account tier.
Optional identifier for the thumbnail file.
Optional identifier for the user who created the account.
Default avatar for the account.
Sequence number for the account.
Optional subscription details for the account.
The unique identifier for the account.
The Stripe customer ID associated with the account.
The current status of the subscription.
The number of licenses associated with the subscription.
The billing frequency of the subscription.
yearly, monthly The contact information for the subscription.
Optional members associated with the account.
The unique identifier of the account.
The unique identifier of the user.
The roles assigned to the user within the account.
The user associated with the account member.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
Optional tier details for the account.
Unique identifier for the account tier.
Type of the account tier.
personal, team Name of the tier type.
Maximum storage allowed for the account tier.
Cost per license for the account tier.
Cost per extra terabyte for the account tier.
Optional type details for the account.
Unique identifier for the account type.
Name of the account type.
Maximum storage allowed for the account type.
Maximum number of assets allowed for the account type.
Maximum number of users allowed for the account type.
Cost per user for the account type.
Additional storage price for the account type.
Optional creator details for the account.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
List of workspaces associated with the account.
Unique identifier for the workspace.
Unique identifier for the account associated with the workspace.
Name of the workspace.
Unique identifier for the thumbnail file associated with the workspace.
Default avatar for the workspace.
1 <= x <= 10Unique identifier for the user who created the workspace.
Sequence number for the workspace.
Roles associated with the workspace.
The ID of the workspace.
The ID of the user.
The roles assigned to the user in the workspace.
The user details.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Usage information for the workspace.
Optional flag indicating if the user is the creator of the account.
Optional list of roles associated with the account.
Represents an account with various properties and relationships.
Unique identifier for the account.
Name of the account.
Identifier for the account tier.
Optional identifier for the thumbnail file.
Optional identifier for the user who created the account.
Default avatar for the account.
Sequence number for the account.
Optional subscription details for the account.
The unique identifier for the account.
The Stripe customer ID associated with the account.
The current status of the subscription.
The number of licenses associated with the subscription.
The billing frequency of the subscription.
yearly, monthly The contact information for the subscription.
Optional members associated with the account.
The unique identifier of the account.
The unique identifier of the user.
The roles assigned to the user within the account.
The user associated with the account member.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
Optional tier details for the account.
Unique identifier for the account tier.
Type of the account tier.
personal, team Name of the tier type.
Maximum storage allowed for the account tier.
Cost per license for the account tier.
Cost per extra terabyte for the account tier.
Optional type details for the account.
Unique identifier for the account type.
Name of the account type.
Maximum storage allowed for the account type.
Maximum number of assets allowed for the account type.
Maximum number of users allowed for the account type.
Cost per user for the account type.
Additional storage price for the account type.
Optional creator details for the account.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
List of workspaces associated with the account.
Unique identifier for the workspace.
Unique identifier for the account associated with the workspace.
Name of the workspace.
Unique identifier for the thumbnail file associated with the workspace.
Default avatar for the workspace.
1 <= x <= 10Unique identifier for the user who created the workspace.
Sequence number for the workspace.
Roles associated with the workspace.
The ID of the workspace.
The ID of the user.
The roles assigned to the user in the workspace.
The user details.
Unique identifier for the user
Auth0 user ID
Username of the user
Email address of the user
First name of the user
Last name of the user
File ID of the user's avatar
Default avatar identifier
Industry the user works in
Occupation of the user
Company the user works for
Whether the user's email is verified
Whether the user is active
City where the user resides
State where the user resides
Country where the user resides
Zip code of the user's location
User who invited this user
Usage information for the workspace.
Optional flag indicating if the user is the creator of the account.
Optional list of roles associated with the account.
Was this page helpful?
curl --request GET \
--url https://api.mudstack.com/users/permissions \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"auth0UserID": "<string>",
"email": "<string>",
"accounts": [
{
"id": "<string>",
"name": "<string>",
"account_tier_id": "<string>",
"thumbnail_file_id": "<string>",
"created_by_user_id": "<string>",
"defaultAvatar": 123,
"sequence": 123,
"subscription": {
"account_id": "<string>",
"stripe_customer_id": "<string>",
"status": "<string>",
"licenses": 123,
"frequency": "yearly",
"contact": "<string>"
},
"members": {
"account_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"tier": {
"id": "<string>",
"type": "personal",
"name": "<string>",
"maxStorage": 123,
"costPerLicense": 123,
"costPerExtraTB": 123
},
"type": {
"id": "<string>",
"name": "<string>",
"maxStorage": 123,
"maxAssets": 123,
"maxUsers": 123,
"costPerUser": 123,
"addStoragePrice": 123
},
"creator": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
},
"workspaces": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"defaultAvatar": 5,
"created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": "<string>",
"roles": {
"workspace_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"usage": {}
}
],
"isCreator": true,
"account_roles": [
"<string>"
]
}
],
"personalAccount": {
"id": "<string>",
"name": "<string>",
"account_tier_id": "<string>",
"thumbnail_file_id": "<string>",
"created_by_user_id": "<string>",
"defaultAvatar": 123,
"sequence": 123,
"subscription": {
"account_id": "<string>",
"stripe_customer_id": "<string>",
"status": "<string>",
"licenses": 123,
"frequency": "yearly",
"contact": "<string>"
},
"members": {
"account_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"tier": {
"id": "<string>",
"type": "personal",
"name": "<string>",
"maxStorage": 123,
"costPerLicense": 123,
"costPerExtraTB": 123
},
"type": {
"id": "<string>",
"name": "<string>",
"maxStorage": 123,
"maxAssets": 123,
"maxUsers": 123,
"costPerUser": 123,
"addStoragePrice": 123
},
"creator": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
},
"workspaces": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"defaultAvatar": 5,
"created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": "<string>",
"roles": {
"workspace_id": "<string>",
"user_id": "<string>",
"roles": [
"<string>"
],
"user": {
"id": "<string>",
"auth0UserID": "<string>",
"username": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar_file_id": "<string>",
"defaultAvatar": 123,
"industry": "<string>",
"occupation": "<string>",
"company": "<string>",
"emailVerified": true,
"isActive": true,
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>",
"invited_by_user": {}
}
},
"usage": {}
}
],
"isCreator": true,
"account_roles": [
"<string>"
]
}
}