A role represents a pre-defined set of capabilities that can be assigned to a [user](#tag/Users) via their [membership](#tag/Memberships) in an [organization](#tag/Organization). By default, the first user in an organization gets assigned an administration role. Subsequent users get assigned the most limited set of capabilities.
swagger: '2.0'
info:
title: The Griffin API keys Roles API
version: ''
description: "## Introduction\n\nThe Griffin API is based on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\nIt has resource-oriented URLs, accepts [JSON](https://www.json.org/json-en.html)-encoded request bodies, returns [JSON](https://www.json.org/json-en.html)-encoded responses, and uses standard HTTP response verbs and response codes.\n\nOur API deviates from strict RESTful principles if it makes sense to do so, such as when we enforce tighter access controls around certain operations.\nFor example, when closing a bank account: rather than send a PATCH request to the [bank account](#tag/Bank-accounts) resource to update it's status to `\"closed\"`, we provide a dedicated account closure resource.\n\nAnyone can [create an account](https://app.griffin.com/register) with Griffin and try out our API in [sandbox mode](/docs/guides/sandbox-vs-live-mode).\n\nNew to Griffin? Check out our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Navigation\n\nOur API is designed to be navigated programmatically. When you request any resource, you will find the URLs for related resources in the response body.\n\nThe API is structured as a tree with your [organization](#tag/Organizations) at the top. Everything that you own will be a sub-resource of your organization.\n\nTo bootstrap the navigation process, request the [index](#tag/Navigation/paths/~1v0~1index/get) endpoint: the response will contain your `organization-url`.\n\nFor a walkthrough, see our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Pagination\n\nOur list APIs support pagination (e.g. [list bank accounts](#tag/Bank-accounts/paths/~1v0~1organizations~1%7Borganization-id%7D~1bank~1accounts/get) and [list payments](#tag/Payments/paths/~1v0~1bank~1accounts~1%7Bbank-account-id%7D~1payments/get)).\nBy default, a list API returns up to 25 results. If there are more results available, the response payload will include links to the previous/next pages.\n\n### Change page size\n\nYou can request a different number of results (between 1 and 200, inclusive) by using the `page[size]` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?page[size]=100\n```\n\n### Navigating between pages\n\nList responses will include a `links` object with `prev` and `next` attributes, as shown below.\nPerform a GET request to the value of the attribute to fetch the previous/next page of results.\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n \"prev\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[before]=djE6WxSPxfYUTnCU9XtWzj9gGA\",\n \"next\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[after]=djE6aw79PXZySUOL16LD8HRJ3A\"\n }\n}\n\n```\nIf there is no previous or next page available, the value of the attribute will be null.\n\nAny other query parameters included in the initial request will also be included in the response payload's links.\nIf you want to change parameters (see [filtering and sorting](#section/Filtering-and-sorting)), request the first page and follow the links from there.\n\n## Filtering and sorting\n\n### Sort results\n\nBy default, resources will be listed in descending order, usually based on the `created-at` attribute.\nYou can change the sorting behaviour of a list of results by using the `sort` query parameter.\n\nFor example, to list bank accounts in ascending order (oldest first):\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=created-at\n```\n\nTo _explicitly_ sort in descending order (newest first), prefix the sort attribute with `-`:\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=-created-at\n```\n\n### Filter results\n\nSome list APIs allow you to filter the results.\nFilters are expressed as nested data structures encoded into query parameters.\nFor example, you can list bank accounts that are in either the `opening` or `open` state with:\n\n```\nGET /v0/organizations/:id/bank/accounts?filter[account-status][in][]=opening&filter[account-status][in][]=open\n```\n\nSimilarly, you can list legal persons with a specific `application-status`:\n\n```\nGET /v0/organizations/:id/legal-persons?filter[application-status][eq]=accepted\n```\n\n### Include resources\n\nSome list APIs allow you to include associated resources in the response, reducing the number of requests needed to fetch related data.\nFor instance, when listing bank accounts, you can include each bank account's beneficiary legal person by using the `include` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?include=beneficiary\n```\n\nThe response returns the usual list of bank accounts, but it will also have an `included` object with a `legal-persons` attribute:\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n // ...\n }\n \"included\": {\n \"legal-persons\": [\n // ...\n ]\n }\n}\n```\n\nCheck the documentation for each list API to see all options for sorting and filtering\n\n## Request limits\n\nEach organization is allowed up to 50 concurrent (in-flight) API requests. Exceeding this threshold results in a 429 - Too Many Requests response. Upon receiving a 429 response, you should implement a backoff strategy, pausing to allow your outstanding requests to complete before attempting new requests. To manage your request rate effectively and avoid surpassing this limit, consider using a controlled approach such as a finite pool of threads or workers.\n\n## Versioning\n\nThe Griffin API is versioned via a prefix in the URL.\nThe current version is v0.\nAn example endpoint is: https://api.griffin.com/v0/index.\n\nWe will not break your integration with a particular version for as long as we support that version.\nIf we release a new version, you will have 12 months to upgrade to it."
host: api.griffin.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- api-key-auth: []
tags:
- name: Roles
description: A role represents a pre-defined set of capabilities that can be assigned to a [user](#tag/Users) via their [membership](#tag/Memberships) in an [organization](#tag/Organization). By default, the first user in an organization gets assigned an administration role. Subsequent users get assigned the most limited set of capabilities.
paths:
/v0/memberships/{membership-id}/roles:
get:
tags:
- Roles
description: Returns the [roles](#tag/Roles) assigned to this [membership](#tag/Memberships).
parameters:
- type: string
required: true
name: membership-id
in: path
responses:
'200':
schema:
type: object
properties:
roles:
type: array
items:
type: object
properties:
display-name:
type: string
minLength: 1
title: display-name
description: A human readable label for an entity
description:
type: string
title: description
role-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
title: role-url
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
description: Link to the [role](#tag/Roles).
role-category:
type: string
required:
- display-name
- description
- role-url
title: role
title: roles
description: Shows a collection of [roles](#tag/Roles).
required:
- roles
title: roles-response
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
type: string
description: Returns `GriffinSession` if no valid authentication is found.
summary: List membership roles
put:
tags:
- Roles
description: 'Assigns [roles](#tag/Roles) to the [membership](#tag/Memberships).
A 422 Unprocessable Entity is served if either:
* one role url provided in the body is not in the [Organisations](#tag/Organizations) `"available-roles"`
* the request attempts to remove the last admin role of the organization, thus making the organisation unusable.'
parameters:
- in: body
name: request-update-membership-roles
description: ''
required: true
schema:
type: object
properties:
role-urls:
type: array
items:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
title: role-url
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
description: Link to the [role](#tag/Roles).
required:
- role-urls
title: request-update-membership-roles
- type: string
required: true
name: membership-id
in: path
responses:
'200':
schema:
type: object
properties:
roles:
type: array
items:
type: object
properties:
display-name:
type: string
minLength: 1
title: display-name
description: A human readable label for an entity
description:
type: string
title: description
role-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
title: role-url
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
description: Link to the [role](#tag/Roles).
role-category:
type: string
required:
- display-name
- description
- role-url
title: role
title: roles
description: Shows a collection of [roles](#tag/Roles).
required:
- roles
title: roles-response
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
type: string
description: Returns `GriffinSession` if no valid authentication is found.
'404':
description: ''
'422':
description: 'Unprocessable Entity is served if either:
* one role url provided in the body is not in the [Organisations](#tag/Organizations) `"available-roles"`
* the request attempts to remove the last admin role of the organization, thus making the organisation unusable.'
summary: Update role
/v0/roles:
get:
tags:
- Roles
description: Yields a list of all Role resources.
security: []
responses:
'200':
schema:
type: object
properties:
roles:
type: array
items:
type: object
properties:
display-name:
type: string
minLength: 1
title: display-name
description: A human readable label for an entity
description:
type: string
title: description
role-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
title: role-url
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
description: Link to the [role](#tag/Roles).
role-category:
type: string
required:
- display-name
- description
- role-url
title: role
title: roles
description: Shows a collection of [roles](#tag/Roles).
required:
- roles
title: roles-response
description: ''
parameters: []
summary: List roles
/v0/roles/{role-id}:
get:
tags:
- Roles
description: Yields the Role resource.
security: []
parameters:
- type: string
required: true
name: role-id
in: path
responses:
'200':
schema:
type: object
properties:
display-name:
type: string
minLength: 1
title: display-name
description: A human readable label for an entity
description:
type: string
title: description
role-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
role-id:
type: string
format: ''
title: role-id
required: true
name: role-id
required:
- role-id
title: role-url
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
description: Link to the [role](#tag/Roles).
role-category:
type: string
required:
- display-name
- description
- role-url
title: role
description: ''
'400':
description: ''
'404':
description: ''
summary: Get role
securityDefinitions:
api-key-auth:
type: apiKey
in: header
name: Authorization
description: 'API token authentication.
It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX`'
x-tagGroups:
- name: Getting started
tags:
- API keys
- Connectivity
- Navigation
- Events
- Webhooks
- Message Signatures
- name: Customer verifications
tags:
- Legal persons
- Legal person history
- Claims
- Workflows
- Verifications
- Decisions
- Companies House
- Reliance onboarding
- name: Banking
tags:
- Bank accounts
- Bank account events
- Bank account restrictions
- Bank account holds
- Pooled account membership
- Payments
- Transactions
- Payees
- Confirmation of payee
- Open banking
- name: Team management
tags:
- Organizations
- Users
- Roles
- Memberships
- Invitations
x-id:
- default