Accounts

The Accounts service is thought to be owning the user, resource group and company information.

• Accounts
  • postCreate an account
  • putUpdate an account
  • delDelete an account
  • putActivate an account
  • putActivate an account
  • putChange an account password
  • getGet an account by id
  • getGet an account by email
  • postCreate a service account
  • postCreate a service account
  • getGet the service account secret
  • getGet the service account secret
  • postUpsert a personal resource group
  • getGet a personal resource group by its short name
  • postUpsert a personal resource group
  • getGet a personal resource group by its short name
  • delDelete a personal resource group
  • delDelete a personal resource group
• Health
  • get/Health
• Organizations
  • postCreate an organization
  • putUpdate an organization
  • getGet an organization
  • delDelete an organization
  • postUpsert an organizational resource group
  • getGet an organizational resource group by shortname
  • delDelete an organizational resource group
  • putGrant an organization permission to a principal
  • delRevoke an organization permission from a principal
  • putGrant an organizational resource group permission to a principal
  • delRevoke an organizational resource group permission from a principal
  • putGrant team permissions to a principal
  • delRevoke a team permission from a principal
  • postUpsert a team
  • getGet a team by shortname
  • delDelete a team

API docs by Redocly

Fractal Accounts (v1)

Download OpenAPI specification:Download

Fractal Cloud: contact-us@fractal.cloud URL: https://fractal.cloud/

Fractal Accounts description

Accounts

Create an account

Authorizations:

Bearer

Request Body schema: application/json

name	string or null
email	string or null
avatarUrl	string or null
phoneNumber	string or null
businessScopes	Array of strings or null unique

Responses

https://docs.fractal.cloud/Accounts

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string",
• "businessScopes": [

  • "string"

  ]

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string",
• "status": "Registered",
• "challenge": "string",
• "forcePasswordChange": true,
• "serviceAccountId": "string"

}

Update an account

Authorizations:

Bearer

Request Body schema: application/json

name	string or null
email	string or null
avatarUrl	string or null
phoneNumber	string or null

Responses

https://docs.fractal.cloud/Accounts/me

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string",
• "status": "Registered",
• "challenge": "string",
• "forcePasswordChange": true,
• "serviceAccountId": "string"

}

Delete an account

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Accounts/me

Response samples

• 200

Content type

application/json

true

Activate an account Deprecated

Authorizations:

Bearer

path Parameters

accountId required

string <uuid>

Request Body schema: application/json

password

string or null <password>

Responses

https://docs.fractal.cloud/Accounts/{accountId}/activate

Request samples

• Payload

Content type

application/json

{

• "password": "pa$$word"

}

Response samples

• 200

Content type

application/json

true

Activate an account

Authorizations:

Bearer

Request Body schema: application/json

password

string or null <password>

Responses

https://docs.fractal.cloud/Accounts/me/activate

Request samples

• Payload

Content type

application/json

{

• "password": "pa$$word"

}

Response samples

• 200

Content type

application/json

true

Change an account password

Authorizations:

Bearer

Request Body schema: application/json

oldPassword	string or null <password>
newPassword	string or null <password>

Responses

https://docs.fractal.cloud/Accounts/me/changepassword

Request samples

• Payload

Content type

application/json

{

• "oldPassword": "pa$$word",
• "newPassword": "pa$$word"

}

Response samples

• 200

Content type

application/json

true

Get an account by id

Authorizations:

Bearer

path Parameters

accountId required

string <uuid>

Responses

https://docs.fractal.cloud/Accounts/{accountId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string",
• "status": "Registered",
• "challenge": "string",
• "forcePasswordChange": true,
• "serviceAccountId": "string"

}

Get an account by email

Authorizations:

Bearer

path Parameters

email required

string

Responses

https://docs.fractal.cloud/Accounts/{email}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "email": "string",
• "avatarUrl": "string",
• "phoneNumber": "string",
• "status": "Registered",
• "challenge": "string",
• "forcePasswordChange": true,
• "serviceAccountId": "string"

}

Create a service account Deprecated

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Accounts/serviceAccount

Response samples

• 200

Content type

application/json

"string"

Create a service account

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Accounts/me/serviceAccount

Response samples

• 200

Content type

application/json

"string"

Get the service account secret Deprecated

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Accounts/serviceAccount/secret

Response samples

• 200

Content type

application/json

"string"

Get the service account secret

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Accounts/me/serviceAccount/secret

Response samples

• 200

Content type

application/json

"string"

Upsert a personal resource group Deprecated

Authorizations:

Bearer

path Parameters

shortName required

string

Request Body schema: application/json

displayName	string or null
description	string or null
icon	string or null

Responses

https://docs.fractal.cloud/Accounts/resourcegroups/{shortName}

Request samples

• Payload

Content type

application/json

{

• "displayName": "string",
• "description": "string",
• "icon": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

Get a personal resource group by its short name Deprecated

Authorizations:

Bearer

path Parameters

shortName required

string

Responses

https://docs.fractal.cloud/Accounts/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

Upsert a personal resource group

Authorizations:

Bearer

path Parameters

shortName required

string

Request Body schema: application/json

displayName	string or null
description	string or null
icon	string or null

Responses

https://docs.fractal.cloud/Accounts/me/resourcegroups/{shortName}

Request samples

• Payload

Content type

application/json

{

• "displayName": "string",
• "description": "string",
• "icon": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

Get a personal resource group by its short name

Authorizations:

Bearer

path Parameters

shortName required

string

Responses

https://docs.fractal.cloud/Accounts/me/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

Delete a personal resource group

Authorizations:

Bearer

path Parameters

shortName required

string

Responses

https://docs.fractal.cloud/Accounts/me/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

true

Delete a personal resource group Deprecated

Authorizations:

Bearer

path Parameters

accountId required	string <uuid>
shortName required	string

Responses

https://docs.fractal.cloud/Accounts/{accountId}/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

true

Health

/Health

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Health

Organizations

Create an organization

Authorizations:

Bearer

Request Body schema: application/json

name	string or null
description	string or null
icon	string or null

Responses

https://docs.fractal.cloud/Organizations

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string",
• "icon": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "icon": "string",
• "admins": [

  • "string"

  ],
• "members": [

  • "string"

  ],
• "teams": [

  • "string"

  ],
• "resourceGroups": [

  • "string"

  ],
• "status": "Unknown"

}

Update an organization

Authorizations:

Bearer

Request Body schema: application/json

organizationId	string <uuid>
name	string or null
description	string or null
icon	string or null

Responses

https://docs.fractal.cloud/Organizations

Request samples

• Payload

Content type

application/json

{

• "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
• "name": "string",
• "description": "string",
• "icon": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "icon": "string",
• "admins": [

  • "string"

  ],
• "members": [

  • "string"

  ],
• "teams": [

  • "string"

  ],
• "resourceGroups": [

  • "string"

  ],
• "status": "Unknown"

}

Get an organization

Authorizations:

Bearer

path Parameters

organizationId required

string <uuid>

Responses

https://docs.fractal.cloud/Organizations/{organizationId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "icon": "string",
• "admins": [

  • "string"

  ],
• "members": [

  • "string"

  ],
• "teams": [

  • "string"

  ],
• "resourceGroups": [

  • "string"

  ],
• "status": "Unknown"

}

Delete an organization

Authorizations:

Bearer

path Parameters

organizationId required

string <uuid>

Responses

https://docs.fractal.cloud/Organizations/{organizationId}

Response samples

• 200

Content type

application/json

true

Upsert an organizational resource group

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Request Body schema: application/json

displayName	string or null
description	string or null
icon	string or null

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/resourcegroups/{shortName}

Request samples

• Payload

Content type

application/json

{

• "displayName": "string",
• "description": "string",
• "icon": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "membersIds": [

  • "string"

  ],
• "teamsIds": [

  • "string"

  ],
• "managersIds": [

  • "string"

  ]

}

Get an organizational resource group by shortname

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "resourceGroupType": "Personal",
  • "ownerId": "string",
  • "shortName": "string"

  },
• "displayName": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "livesystems": [

  • "string"

  ],
• "fractals": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "membersIds": [

  • "string"

  ],
• "teamsIds": [

  • "string"

  ],
• "managersIds": [

  • "string"

  ]

}

Delete an organizational resource group

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/resourcegroups/{shortName}

Response samples

• 200

Content type

application/json

true

Grant an organization permission to a principal

Authorizations:

Bearer

path Parameters

organizationId required

string <uuid>

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Revoke an organization permission from a principal

Authorizations:

Bearer

path Parameters

organizationId required

string <uuid>

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Grant an organizational resource group permission to a principal

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/resourcegroups/{shortName}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Revoke an organizational resource group permission from a principal

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/resourcegroups/{shortName}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Grant team permissions to a principal

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/teams/{shortName}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Revoke a team permission from a principal

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortName required	string

Request Body schema: application/json

principalType	string (PrincipalType) Enum: "Account" "Team"
principalId	string or null The identifier of the principal: Organization → GUID (e.g. 2cf133e2-6f35-4179-802e-51376ac79141).Account → email (e.g. example@fractal.cloud).
permissionType	string (PermissionType) Enum: "Admin" "Edit" "Terminate" "View"

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/teams/{shortName}/permissions

Request samples

• Payload

Content type

application/json

{

• "principalType": "Account",
• "principalId": "string",
• "permissionType": "Admin"

}

Response samples

• 200

Content type

application/json

true

Upsert a team

Authorizations:

Bearer

path Parameters

organizationId required

string <uuid>

Request Body schema: application/json

shortName	string or null
name	string or null
description	string or null
icon	string or null
isPrivate	boolean

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/teams

Request samples

• Payload

Content type

application/json

{

• "shortName": "string",
• "name": "string",
• "description": "string",
• "icon": "string",
• "isPrivate": true

}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "shortName": "string"

  },
• "name": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "isPrivate": true

}

Get a team by shortname

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortname required	string

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/teams/{shortname}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "shortName": "string"

  },
• "name": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "isPrivate": true

}

Delete a team

Authorizations:

Bearer

path Parameters

organizationId required	string <uuid>
shortname required	string

Responses

https://docs.fractal.cloud/Organizations/{organizationId}/teams/{shortname}

Response samples

• 200

Content type

application/json

{

• "id": {

  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "shortName": "string"

  },
• "name": "string",
• "description": "string",
• "status": "Unknown",
• "icon": "string",
• "isPrivate": true

}