Turia

• Healthcheck
  • getCheck API status
• Members
  • getReturns a list of members of the organization
  • postAdd a member to the organization
  • delRemoves a member from the organization using their UUID
  • getRetrieve grants assigned to a member
  • patchAdd or remove roles and permissions for a member
  • patchAdd or remove roles and permissions for multiple members at once
• Access-Control
  • getRetrieve access control settings
  • postCreate access control
  • patchUpdate access control settings
• Permissions
  • getGet Products And Permissions
• Roles
  • getRetrieve roles
  • postCreate a new role
  • delDelete a role
  • getRetrieve permissions of a role
  • patchUpdate role permissions
  • getRetrieve members of a role
• Service-Accounts
  • getRetrieve service accounts
  • postCreate service account
  • delRemove service account
  • patchUpdate service account
  • postCreate API key for service account
  • getGet API keys for a service account
  • delRevoke an API key for a service account
  • patchUpdate API key
• Scopes
  • getList scope groups, products, and scopes

API docs by Redocly

Turia IAM API Product (1.0.0)

Turia IAM API Product

Healthcheck

Operations for checking the API status.

Check API status

Responses

https://docs.magalu.cloud/api/v1/healthcheck

Response samples

• 200

Content type

application/json

{

• "status": "OK"

}

Members

Operations with members, including creation, listing, deletion, and management of individual or batch grants.

Returns a list of members of the organization

Authorizations:

OAuth2

query Parameters

Email (string) or Email (null) (Email) Example: email=john.doe@example.com

Responses

https://docs.magalu.cloud/api/v1/members

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "uuid": "550e8400-e29b-41d4-a716-446655440000",
  • "email": "john.doe@example.com",
  • "name": "John Doe",
  • "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  • "profile": "administrator"

  }

]

Add a member to the organization

Authorizations:

OAuth2

Request Body schema: application/json

required

email required	string <email> (Email)
roles	Array of strings (Roles)
permissions	Array of strings (Permissions)

Responses

https://docs.magalu.cloud/api/v1/members

Request samples

• Payload

Content type

application/json

{

• "email": "user@example.com",
• "roles": [

  • "editor"

  ],
• "permissions": [

  • "turia_iam_editor"

  ]

}

Response samples

• 200
• 403
• 422

Content type

application/json

{

• "uuid": "550e8400-e29b-41d4-a716-446655440000",
• "email": "john.doe@example.com",
• "name": "John Doe",
• "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
• "profile": "administrator"

}

Removes a member from the organization using their UUID

Authorizations:

OAuth2

path Parameters

uuid required

string <uuid> (Uuid) Example: 9f1c2d3e-4567-89ab-cdef-1234567890ab

https://docs.magalu.cloud/api/v1/members/{uuid}

Retrieve grants assigned to a member

Authorizations:

OAuth2

path Parameters

uuid required

string <uuid> (Uuid) Example: 9f1c2d3e-4567-89ab-cdef-1234567890ab

Responses

https://docs.magalu.cloud/api/v1/members/{uuid}/grants

Response samples

• 200
• 403
• 422

Content type

application/json

{

• "roles": [

  • "editor"

  ],
• "permissions": [

  • "turia_iam_editor"

  ]

}

Add or remove roles and permissions for a member

Authorizations:

OAuth2

path Parameters

uuid required

string <uuid> (Uuid) Example: 9f1c2d3e-4567-89ab-cdef-1234567890ab

Request Body schema: application/json

required

operation required	string (Operation) Enum: "add" "remove"
roles	Array of strings (Roles) Default: []
permissions	Array of strings (Permissions) Default: []

Responses

https://docs.magalu.cloud/api/v1/members/{uuid}/grants

Request samples

• Payload

Content type

application/json

{

• "operation": "add",
• "roles": [

  • "editor"

  ],
• "permissions": [

  • "turia_iam_editor"

  ]

}

Response samples

• 403
• 422

Content type

application/json

{

• "origin": "permissionsAPI",
• "permission": "turia_iam_editor",
• "product": "turiaiam",
• "message": "User action not authorized for permission turia_iam_editor"

}

Add or remove roles and permissions for multiple members at once

Authorizations:

OAuth2

Request Body schema: application/json

required

member_ids required	Array of strings <uuid> (Member Ids) [ items <uuid > ]
operation required	string (Operation) Enum: "add" "remove"
role_names	Array of strings (Role Names) Default: []
permission_names	Array of strings (Permission Names) Default: []

Responses

https://docs.magalu.cloud/api/v1/members/grants/batch

Request samples

• Payload

Content type

application/json

{

• "member_ids": [

  • "550e8400-e29b-41d4-a716-446655440000"

  ],
• "operation": "add",
• "role_names": [

  • "editor"

  ],
• "permission_names": [

  • "turia_iam_editor"

  ]

}

Response samples

• 403
• 422

Content type

application/json

{

• "origin": "permissionsAPI",
• "permission": "turia_iam_editor",
• "product": "turiaiam",
• "message": "User action not authorized for permission turia_iam_editor"

}

Access-Control

Operations with access control, including detailed retrieval, creation, and updating of settings

Retrieve access control settings

Authorizations:

OAuth2

Responses

https://docs.magalu.cloud/api/v1/access-control

Response samples

• 200
• 403

Content type

application/json

{

• "name": "Turia",
• "description": "Organization managing IAM and access settings.",
• "tenant_id": "8e4f75f4-4298-49e7-87c9-652178c0ecd0",
• "enabled": true,
• "enforce_mfa": true

}

Create access control

Authorizations:

OAuth2

Request Body schema: application/json

required

required	Name (string) or Name (null) (Name)
	Description (string) or Description (null) (Description)
	User (string) or User (null) (User)

Responses

https://docs.magalu.cloud/api/v1/access-control

Request samples

• Payload

Content type

application/json

{

• "name": "Turia",
• "description": "Organization managing IAM and access settings.",
• "user": "string"

}

Response samples

• 201
• 403
• 422

Content type

application/json

{

• "name": "Turia",
• "description": "Organization managing IAM and access settings.",
• "tenant_id": "8e4f75f4-4298-49e7-87c9-652178c0ecd0",
• "enabled": true,
• "enforce_mfa": true

}

Update access control settings

Authorizations:

OAuth2

Request Body schema: application/json

required

status	boolean (Status)
enforce_mfa	boolean (Enforce Mfa)

Responses

https://docs.magalu.cloud/api/v1/access-control

Request samples

• Payload

Content type

application/json

{

• "status": true,
• "enforce_mfa": true

}

Response samples

• 200
• 403
• 422

Content type

application/json

{

• "name": "Turia",
• "description": "Organization managing IAM and access settings.",
• "tenant_id": "8e4f75f4-4298-49e7-87c9-652178c0ecd0",
• "enabled": true,
• "enforce_mfa": true

}

Permissions

Operations with permissions, including listing all available permissions.

Get Products And Permissions

Authorizations:

OAuth2

query Parameters

	Product Name (string) or Product Name (null) (Product Name)
	Partial Match (boolean) or Partial Match (null) (Partial Match) Default: false
	Case Sensitive (boolean) or Case Sensitive (null) (Case Sensitive) Default: true

Responses

https://docs.magalu.cloud/api/v1/permissions

Response samples

• 200
• 403
• 422

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "permissions": [

    • {

      • "id": "string",
      • "name": "string",
      • "description": "string"

      }

    ]

  }

]

Roles

Operations with roles, including creation, listing, deletion, permission management, and member listing.

Retrieve roles

Authorizations:

OAuth2

query Parameters

role_name

string Example: role_name=editor Optional role name to filter results

Responses

https://docs.magalu.cloud/api/v1/roles

Response samples

• 200
• 403
• 422

Content type

application/json

[

• {

  • "name": "financeiro",
  • "description": "Papel com responsabilidade de leitura de dados de faturamento.",
  • "origin": "default"

  }

]

Create a new role

Authorizations:

OAuth2

Request Body schema: application/json

required

name required	string (Name)
description	string (Description)
permissions	Array of strings (Permissions) Default: []
based_role	string (Based Role)

Responses

https://docs.magalu.cloud/api/v1/roles

Request samples

• Payload

Content type

application/json

{

• "name": "manager",
• "description": "Role with administrative privileges for managing users.",
• "permissions": [

  • "turia_iam_editor"

  ],
• "based_role": "editor"

}

Response samples

• 201
• 400
• 403

Content type

application/json

{

• "name": "financeiro",
• "description": "Papel com responsabilidade de leitura de dados de faturamento.",
• "origin": "default"

}

Delete a role

Authorizations:

OAuth2

path Parameters

role_name required

string (Role Name)

Responses

https://docs.magalu.cloud/api/v1/roles/{role_name}

Response samples

• 403
• 422

Content type

application/json

{

• "origin": "permissionsAPI",
• "permission": "turia_iam_editor",
• "product": "turiaiam",
• "message": "User action not authorized for permission turia_iam_editor"

}

Retrieve permissions of a role

Authorizations:

OAuth2

path Parameters

role_name required

string (Role Name)

Responses

https://docs.magalu.cloud/api/v1/roles/{role_name}/permissions

Response samples

• 200
• 403
• 422

Content type

application/json

{

• "name": "manager",
• "description": "Role with administrative privileges for managing users",
• "origin": "custom",
• "permissions": [

  • "turia_iam_editor"

  ]

}

Update role permissions

Authorizations:

OAuth2

path Parameters

role_name required

string (Role Name) Example: manager Name of the role to update

Request Body schema: application/json

required

add	Array of strings (Add) Default: []
remove	Array of strings (Remove) Default: []

Responses

https://docs.magalu.cloud/api/v1/roles/{role_name}/permissions

Request samples

• Payload

Content type

application/json

{

• "add": [

  • "turia_iam_adm"

  ],
• "remove": [

  • "turia_iam_editor"

  ]

}

Response samples

• 200
• 403
• 422

Content type

application/json

[

• {

  • "name": "financeiro",
  • "description": "Papel com responsabilidade de leitura de dados de faturamento.",
  • "origin": "default"

  }

]

Retrieve members of a role

Authorizations:

OAuth2

path Parameters

role_name required

string (Role Name)

Responses

https://docs.magalu.cloud/api/v1/roles/{role_name}/members

Response samples

• 200
• 403
• 422

Content type

application/json

[

• {

  • "member_uuid": "a4bddb3f-0acf-4981-bb85-03feb4ee0d08",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "member_role": "administrator",
  • "profile_image_url": "https://example.com/profile.jpg",
  • "roles": [

    • "editor"

    ]

  }

]

Service-Accounts

Operations with service accounts, including creation, listing, editing, deletion, and management of their API keys.

Retrieve service accounts

Authorizations:

OAuth2

Responses

https://docs.magalu.cloud/api/v1/service-accounts

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "uuid": "d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a",
  • "name": "Analytics Engine",
  • "description": "Service account for analytics pipelines",
  • "email": "analytics.engine.001@company.example.com",
  • "tenant": {

    • "uuid": "f1a2b3c4-5678-90ab-cdef-1234567890ab",
    • "legal_name": "Example Corp Ltda"

    }

  }

]

Create service account

Authorizations:

OAuth2

Request Body schema: application/json

required

name required	string (Name)
description required	string (Description)
email required	string <email> (Email)

Responses

https://docs.magalu.cloud/api/v1/service-accounts

Request samples

• Payload

Content type

application/json

{

• "name": "Analytics Engine",
• "description": "Service account for analytics pipelines",
• "email": "analytics.engine.001@company.example.com"

}

Response samples

• 201
• 403
• 422

Content type

application/json

{

• "uuid": "d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a",
• "name": "Analytics Engine",
• "description": "Service account for analytics pipelines",
• "email": "analytics.engine.001@company.example.com",
• "tenant": {

  • "uuid": "f1a2b3c4-5678-90ab-cdef-1234567890ab",
  • "legal_name": "Example Corp Ltda"

  }

}

Remove service account

Authorizations:

OAuth2

path Parameters

sa_uuid required

string <uuid> (Service Account Uuid) Example: d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}

Response samples

• 403
• 404
• 422

Content type

application/json

{

• "origin": "permissionsAPI",
• "permission": "turia_iam_editor",
• "product": "turiaiam",
• "message": "User action not authorized for permission turia_iam_editor"

}

Update service account

Authorizations:

OAuth2

path Parameters

sa_uuid required

string <uuid> (Service Account Uuid) Example: d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a

Request Body schema: application/json

required

	Name (string) or Name (null) (Name)
	Description (string) or Description (null) (Description)

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}

Request samples

• Payload

Content type

application/json

{

• "name": "Analytics Engine",
• "description": "Service account for analytics pipelines"

}

Response samples

• 200
• 403
• 404
• 422

Content type

application/json

{

• "uuid": "d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a",
• "name": "Analytics Engine",
• "description": "Service account for analytics pipelines",
• "email": "analytics.engine.001@company.example.com",
• "tenant": {

  • "uuid": "f1a2b3c4-5678-90ab-cdef-1234567890ab",
  • "legal_name": "Example Corp Ltda"

  }

}

Create API key for service account

Authorizations:

OAuth2

path Parameters

sa_uuid required

string <uuid> (Service Account Uuid) Example: d4f3a9c2-1b8a-4e6b-b5a1-9f2d3e7c4b1a

Request Body schema: application/json

required

name required	string (Name)
	Description (string) or Description (null) (Description)
	Array of Scopes (strings) or Scopes (null) (Scopes) Default: []

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}/api-keys

Request samples

• Payload

Content type

application/json

{

• "name": "Analytics Key",
• "description": "Key for accessing analytics service",
• "scopes": [

  • "iam:read"

  ]

}

Response samples

• 201
• 403
• 404
• 422

Content type

application/json

{

• "uuid": "e8a77a53-ea0b-49a7-9f8d-a7116a800df5",
• "name": "Analytics Key",
• "description": "Key for accessing analytics service",
• "key_pair_id": "be88e4f8-24ac-4cab-a59d-42cfdc02cbe7",
• "key_pair_secret": "8b4c58bc-d905-435b-8cd0-05bf4b150d52",
• "scopes": [

  • "iam:read"

  ],
• "scopes_pending_approval": [

  • "iam:write"

  ],
• "start_validity": "string",
• "end_validity": "string",
• "revoked_at": "string",
• "revoked_by": "string",
• "api_key": "eeac0a24-9948-4e92-b5d4-0aa2ea91d539"

}

Get API keys for a service account

Authorizations:

OAuth2

path Parameters

sa_uuid required

string <uuid> (Sa Uuid) Example: 8cf19575-674c-4bb0-b5c7-4dde54923183

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}/api-keys

Response samples

• 200
• 403
• 422

Content type

application/json

[

• {

  • "uuid": "e8a77a53-ea0b-49a7-9f8d-a7116a800df5",
  • "name": "Analytics Key",
  • "description": "Key for accessing analytics service",
  • "key_pair_id": "be88e4f8-24ac-4cab-a59d-42cfdc02cbe7",
  • "key_pair_secret": "8b4c58bc-d905-435b-8cd0-05bf4b150d52",
  • "scopes": [

    • "iam:read"

    ],
  • "scopes_pending_approval": [

    • "iam:write"

    ],
  • "start_validity": "string",
  • "end_validity": "string",
  • "revoked_at": "string",
  • "revoked_by": "string",
  • "api_key": "eeac0a24-9948-4e92-b5d4-0aa2ea91d539"

  }

]

Revoke an API key for a service account

Authorizations:

OAuth2

path Parameters

sa_uuid required	string <uuid> (Sa Uuid) Example: 8cf19575-674c-4bb0-b5c7-4dde54923183
apikey_uuid required	string <uuid> (Apikey Uuid) Example: e8a77a53-ea0b-49a7-9f8d-a7116a800df5

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}/api-keys/{apikey_uuid}

Response samples

• 403
• 422

Content type

application/json

{

• "origin": "permissionsAPI",
• "permission": "turia_iam_editor",
• "product": "turiaiam",
• "message": "User action not authorized for permission turia_iam_editor"

}

Update API key

Authorizations:

OAuth2

path Parameters

sa_uuid required	string <uuid> (Sa Uuid) Example: 8cf19575-674c-4bb0-b5c7-4dde54923183
apikey_uuid required	string <uuid> (Apikey Uuid) Example: e8a77a53-ea0b-49a7-9f8d-a7116a800df5

Request Body schema: application/json

required

	Name (string) or Name (null) (Name)
	Description (string) or Description (null) (Description)
	Array of Scopes (strings) or Scopes (null) (Scopes) Default: []

Responses

https://docs.magalu.cloud/api/v1/service-accounts/{sa_uuid}/api-keys/{apikey_uuid}

Request samples

• Payload

Content type

application/json

{

• "name": "My API Key",
• "description": "API key for automation tasks",
• "scopes": [

  • "iam:read"

  ]

}

Response samples

• 200
• 403
• 422

Content type

application/json

{

• "uuid": "e8a77a53-ea0b-49a7-9f8d-a7116a800df5",
• "name": "Analytics Key",
• "description": "Key for accessing analytics service",
• "key_pair_id": "be88e4f8-24ac-4cab-a59d-42cfdc02cbe7",
• "key_pair_secret": "8b4c58bc-d905-435b-8cd0-05bf4b150d52",
• "scopes": [

  • "iam:read"

  ],
• "scopes_pending_approval": [

  • "iam:write"

  ],
• "start_validity": "string",
• "end_validity": "string",
• "revoked_at": "string",
• "revoked_by": "string",
• "api_key": "eeac0a24-9948-4e92-b5d4-0aa2ea91d539"

}

Scopes

Operations with scopes, including listing all available API scopes.

List scope groups, products, and scopes

Authorizations:

OAuth2

Responses

https://docs.magalu.cloud/api/v1/scopes

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "uuid": "c5457157-4359-44d7-a0ed-188362c91013",
  • "name": "Magalu Cloud",
  • "api_products": [

    • {

      • "uuid": "1dcfa8ce-4576-4944-a4fe-a0ca1f2f455d",
      • "name": "API Product CMS",
      • "scopes": [

        • {

          • "uuid": "28beb8a2-9d99-44db-8fb7-5b724eac79a2",
          • "name": "cms:cloud-product-management:write",
          • "title": "Write permission for cloud product management"

          }

        ]

      }

    ]

  }

]