Custom Roles

Update a custom role

Changed on

Updates an existing custom role's name, description, and permission statements.

post/teams/{team_id}/update_custom_role

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/teams/{team_id}/update_custom_role
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

team_idinteger required

Team ID

Request body

idinteger required
namestring required
descriptionstring nullable

Example request

{
  "statements": [
    {
      "resource": "project:*"
    }
  ]
}

Response

idinteger required
teamIdinteger required
namestring required
descriptionstring nullable
creatorinteger
createTimeinteger required

Example response

{
  "statements": [
    {
      "resource": "project:*"
    }
  ]
}

Changes

  • d5ab97149ad8Revision changes
    • warning

      added the new team:domain:create enum value to the //// response property for the response status

    • warning

      added the new team:domain:delete enum value to the //// response property for the response status

    • warning

      added the new team:domain:view enum value to the //// response property for the response status

    • info

      added the new team:domain:create enum value to the request property ////

    • info

      added the new team:domain:delete enum value to the request property ////

    • info

      added the new team:domain:view enum value to the request property ////

  • 005e83eb28f0Revision changes
    • warning

      added the new deployment:aiGateway:use enum value to the //// response property for the response status

    • warning

      added the new directorySync:deleteGroupMapping enum value to the //// response property for the response status

    • warning

      added the new directorySync:disable enum value to the //// response property for the response status

    • warning

      added the new directorySync:enable enum value to the //// response property for the response status

    • warning

      added the new directorySync:updateGroupMapping enum value to the //// response property for the response status

    • warning

      added the new directorySync:view enum value to the //// response property for the response status

    • info

      added the new deployment:aiGateway:use enum value to the request property ////

    • info

      added the new directorySync:deleteGroupMapping enum value to the request property ////

    • info

      added the new directorySync:disable enum value to the request property ////

    • info

      added the new directorySync:enable enum value to the request property ////

    • info

      added the new directorySync:updateGroupMapping enum value to the request property ////

    • info

      added the new directorySync:view enum value to the request property ////