Skip to content

Bulk upsert AWS permission sets into the cache

PUT
/v1/aws/permission-sets
curl --request PUT \
--url https://example.com/v1/aws/permission-sets \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--data '{ "resources": [ { "id": "example", "name": "example", "account_id": "example", "metadata": {}, "rank": 1 } ] }'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Media type application/json
object
resources
required
Array<object>
object
id
required
string
name
required
string
account_id
string
nullable
metadata
object
key
additional properties
any
rank
integer
nullable
Example generated
{
"resources": [
{
"id": "example",
"name": "example",
"account_id": "example",
"metadata": {},
"rank": 1
}
]
}

OK

Media type application/json
object
upserted
required

Number of records inserted or updated.

integer
Example generated
{
"upserted": 1
}

Bad Request

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}