# copyCannedRole

mutation · in the family [Identity and access](/reference/identity-and-access/)

## What it does

Copy a platform-preset role template you can copy into your group into your own group — your editable copy of the platform preset.

COPY-TO-CUSTOMIZE a canned role template: mints an ORDINARY editable group Role carrying the template's compiled descriptors + the PORT-stamped provenance (templateKey/templateVersion — never caller-suppliable) + the authorityTier. Requires the unrestricted capability.

## Who may call it

Capability area: **Identity and access** — Who can sign in and what each role allows — users, roles and their assignments.

- Owner
- System Administrator
- An API key whose scope allows `api:copyCannedRole`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `input` | [CopyCannedRoleInput](/types/CopyCannedRoleInput/) `CopyCannedRoleInput!` | yes | No further notes. |

## Returns

[Role](/types/Role/) `Role!` — A role — the group-scoped, merchant-authored authorization construct: 0..N allow/disallow descriptors over the service:action naming universe. Evaluation is flat: default-DENY, union the allow descriptors across the session-user acted-org ACTIVE roles, any matching disallow ALWAYS wins; per-segment \* wildcards; no specificity ranking.

## Example request

```graphql
mutation ExampleCopyCannedRole($input: CopyCannedRoleInput!) {
  copyCannedRole(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    templateKey
    templateVersion
    authorityTier
  }
}
```

Variables:

```json
{
  "input": {
    "key": "owner",
    "caption": "Blue jeans"
  }
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "copyCannedRole": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RL-EXMP-0000-000F",
      "type": "Role",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "templateKey": "owner",
      "templateVersion": 1,
      "authorityTier": "owner"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))

## Used in

- [Shape a role from a canned template](/use-cases/shape-a-role/)