Access Control#

Cloud instance groups and grants

List cloud groups#

GET/organizations/{org_id}/cloud/groups

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "slug": "string",
      "external_id": "string",
      "description": "string",
      "created_by": "550e8400-e29b-41d4-a716-446655440000",
      "created_at": "2025-10-02T15:30:00Z",
      "updated_at": "2025-10-02T15:30:00Z",
      "metadata": {}
    }
  ],
  "meta": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Create cloud group#

POST/organizations/{org_id}/cloud/groups

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "name": "string",
  "slug": "string",
  "description": "string",
  "metadata": {}
}

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"slug": "string",
"description": "string",
"metadata": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "string",
  "slug": "string",
  "description": "string",
  "metadata": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "slug": "string",
  "external_id": "string",
  "description": "string",
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z",
  "metadata": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Update cloud group#

PATCH/organizations/{org_id}/cloud/groups/{group_id}

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`group_id`	string	path	Yes	Cloud group ID

Request Body#

{
  "name": "string",
  "description": "string",
  "metadata": {}
}

Code Examples#

curl -X PATCH "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string",
"metadata": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000", {
method: "PATCH",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "string",
  "description": "string",
  "metadata": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "slug": "string",
  "external_id": "string",
  "description": "string",
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z",
  "metadata": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Get cloud user attributes#

GET/organizations/{org_id}/cloud/users/{user_id}/attributes

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`user_id`	string	path	Yes

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/users/550e8400-e29b-41d4-a716-446655440000/attributes" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/users/550e8400-e29b-41d4-a716-446655440000/attributes", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "synced_attributes": {},
  "manual_attributes": {},
  "effective_attributes": {},
  "source": "string",
  "updated_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Update cloud user manual attributes#

PUT/organizations/{org_id}/cloud/users/{user_id}/attributes

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`user_id`	string	path	Yes

Request Body#

{
  "manual_attributes": {}
}

Code Examples#

curl -X PUT "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/users/550e8400-e29b-41d4-a716-446655440000/attributes" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"manual_attributes": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/users/550e8400-e29b-41d4-a716-446655440000/attributes", {
method: "PUT",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "manual_attributes": {}
})
});

const data = await response.json();

Responses#

{
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "synced_attributes": {},
  "manual_attributes": {},
  "effective_attributes": {},
  "source": "string",
  "updated_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Sync SCIM cloud groups#

PUT/organizations/{org_id}/cloud/scim/groups

Upsert SCIM-managed groups and replace their membership snapshots for an organization.

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "groups": [
    {
      "external_id": "string",
      "display_name": "string",
      "slug": "string",
      "description": "string",
      "members": [
        {
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "attributes": {}
        }
      ]
    }
  ]
}

Code Examples#

curl -X PUT "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/scim/groups" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"groups": [
  {
    "external_id": "string",
    "display_name": "string",
    "slug": "string",
    "description": "string",
    "members": [
      {
        "user_id": "550e8400-e29b-41d4-a716-446655440000",
        "attributes": {}
      }
    ]
  }
]
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/scim/groups", {
method: "PUT",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "groups": [
    {
      "external_id": "string",
      "display_name": "string",
      "slug": "string",
      "description": "string",
      "members": [
        {
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "attributes": {}
        }
      ]
    }
  ]
})
});

const data = await response.json();

Responses#

{
  "groups_synced": 0,
  "memberships_synced": 0,
  "attributes_synced": 0
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

List cloud group members#

GET/organizations/{org_id}/cloud/groups/{group_id}/members

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`group_id`	string	path	Yes	Cloud group ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "group_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "added_by": "550e8400-e29b-41d4-a716-446655440000",
      "added_at": "2025-10-02T15:30:00Z"
    }
  ],
  "meta": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Add cloud group member#

POST/organizations/{org_id}/cloud/groups/{group_id}/members

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`group_id`	string	path	Yes	Cloud group ID

Request Body#

{
  "user_id": "550e8400-e29b-41d4-a716-446655440000"
}

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"user_id": "550e8400-e29b-41d4-a716-446655440000"
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "user_id": "550e8400-e29b-41d4-a716-446655440000"
})
});

const data = await response.json();

Responses#

{
  "group_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "added_by": "550e8400-e29b-41d4-a716-446655440000",
  "added_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Remove cloud group member#

DELETE/organizations/{org_id}/cloud/groups/{group_id}/members/{user_id}

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`group_id`	string	path	Yes	Cloud group ID
`user_id`	string	path	Yes

Code Examples#

curl -X DELETE "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/groups/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000", {
method: "DELETE",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

No response body

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

List cloud grants#

GET/organizations/{org_id}/cloud/instances/{instance_id}/grants

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`instance_id`	string	path	Yes	Cloud instance ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "cloud_instance_id": "550e8400-e29b-41d4-a716-446655440000",
      "subject_type": "user",
      "subject_id": "550e8400-e29b-41d4-a716-446655440000",
      "table_name": "string",
      "actions": [
        "string"
      ],
      "row_filter": {},
      "row_filter_template": {},
      "metadata": {},
      "created_by": "550e8400-e29b-41d4-a716-446655440000",
      "created_at": "2025-10-02T15:30:00Z",
      "updated_at": "2025-10-02T15:30:00Z"
    }
  ],
  "meta": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Upsert cloud grant#

PUT/organizations/{org_id}/cloud/instances/{instance_id}/grants

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`instance_id`	string	path	Yes	Cloud instance ID

Request Body#

{
  "subject_type": "user",
  "subject_id": "550e8400-e29b-41d4-a716-446655440000",
  "table_name": "*",
  "actions": [
    "string"
  ],
  "row_filter": {},
  "row_filter_template": {},
  "metadata": {}
}

Code Examples#

curl -X PUT "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"subject_type": "user",
"subject_id": "550e8400-e29b-41d4-a716-446655440000",
"table_name": "*",
"actions": [
  "string"
],
"row_filter": {},
"row_filter_template": {},
"metadata": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants", {
method: "PUT",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "subject_type": "user",
  "subject_id": "550e8400-e29b-41d4-a716-446655440000",
  "table_name": "*",
  "actions": [
    "string"
  ],
  "row_filter": {},
  "row_filter_template": {},
  "metadata": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "cloud_instance_id": "550e8400-e29b-41d4-a716-446655440000",
  "subject_type": "user",
  "subject_id": "550e8400-e29b-41d4-a716-446655440000",
  "table_name": "string",
  "actions": [
    "string"
  ],
  "row_filter": {},
  "row_filter_template": {},
  "metadata": {},
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Delete cloud grant#

DELETE/organizations/{org_id}/cloud/instances/{instance_id}/grants/{grant_id}

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`instance_id`	string	path	Yes	Cloud instance ID
`grant_id`	string	path	Yes

Code Examples#

curl -X DELETE "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/grants/550e8400-e29b-41d4-a716-446655440000", {
method: "DELETE",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

No response body

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}