Create a New Role

POST 
/user-svc/role

Create a new role. The role ID must be prefixed by the callers username (email). Eg. if the owner's slug is petstore-svc the role should look like petstore-svc:admin. The user account who creates the role will become the owner of that role, and only the owner will be able to edit the role.

Requires the user-svc:role:create permission.

Request

application/json

Body

required

Create Role Request

description string
name string
permissionIds string[]

Responses

200

Role created successfully

application/json

Schema

Schema

role

object

createdAt string

description string

id string

name string

ownerId string

updatedAt string

Example (from schema)

{
  "role": {
    "createdAt": "string",
    "description": "string",
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "updatedAt": "string"
  }
}

400

Invalid JSON

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...