Update custom role (API Explorer)

Platform API ReferenceOrganization
Platform API ReferenceAlerts
Platform API ReferenceOptions
- GETGet cluster options
- GETGet Deployment options
Platform API ReferenceCluster
Platform API ReferenceDeployment
Platform API ReferenceDeploy
Platform API ReferenceEnvironment
Platform API ReferenceNotification Channels
Platform API ReferenceWorkspace
IAM API ReferenceAuthorization
- GETList authorization permission groups
IAM API ReferenceAllowed IP Address Range
IAM API ReferenceInvite
- POSTCreate a user invitation
- DELDelete a user invite
IAM API ReferenceRole
IAM API ReferenceTeam
IAM API ReferenceAPI Token
IAM API ReferenceUser

Built with

POSThttps://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/customRoleId

Path Parameters

organizationIdstringRequired
customRoleIdstringRequired

Body Parameters

namestringRequired
permissionslist of stringsRequired(1 item)
- 1
descriptionstring
restrictedWorkspaceIdslist of strings(1 item)
- 1

View in API Reference

Request

$ curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/customRoleId \
>      -H "Authorization: Bearer " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "description": "Subject can only view deployments.",
>   "name": "Deployment_Viewer",
>   "permissions": [
>     "deployment.get"
>   ],
>   "restrictedWorkspaceIds": [
>     "cldbvzoi20182g8odxt8ehi5i"
>   ]
> }'

Response

$	curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/customRoleId \
>	-H "Authorization: Bearer " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"description": "Subject can only view deployments.",
>	"name": "Deployment_Viewer",
>	"permissions": [
>	"deployment.get"
>	],
>	"restrictedWorkspaceIds": [
>	"cldbvzoi20182g8odxt8ehi5i"
>	]
>	}'