{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-apis/platform/iam/sidebars.yaml","oas-apis/platform/iam/openapi/iam-openapi.json":"oas-apis/platform/iam/openapi/iam-openapi.json"},"props":{"metadata":{"markdoc":{"tagList":["openapi-code-sample","admonition"]},"type":"markdown"},"seo":{"title":"Groups","keywords":"documentation, api, portal, banking, payment, account information, aritma, psd2, open banking, reconciliation","description":"Developer documentation for Aritma's banking and financial APIs - payments, account information, webhooks, authentication and integrations.","meta":[{"name":"google-site-verification","content":"hplqlK_5O42BZjNnjtVQMEpxv9JkxcD1eH4J1T-NQmI"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"groups","__idx":0},"children":["Groups"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Groups let you manage access for multiple subjects at once. Instead of granting permissions to each user or client individually, you can add them to a group and apply policies to the group as a whole."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-groups","__idx":1},"children":["When to use groups"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A team of users needs the same access to a subscription"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want to onboard new users with a predefined permission set"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You need to revoke access for an entire team in one step"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-groups","__idx":2},"children":["List groups"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve all subject groups in your tenant:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"GetSubjectGroups","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-group","__idx":3},"children":["Create a group"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"CreateSubjectGroup","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"displayName\": \"Finance Team\",\n  \"subjectId\": \"group-7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"type\": \"Group\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," - you will need it for all subsequent group operations. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subjectId"]}," is the group's subject identifier used when creating policies targeting the group."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Applying policies to groups"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To grant a group permissions, create a policy with the group's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subjectId"]}," as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]},". See the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/policies"},"children":["Policies guide"]}," for details."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-members-to-a-group","__idx":4},"children":["Add members to a group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can add one or more subjects (users or clients) to a group in a single request:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"AddSubjectsToSubjectGroup","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example request body:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subjectIds\": [\n    \"user-550e8400-e29b-41d4-a716-446655440000\",\n    \"user-6ba7b810-9dad-11d1-80b4-00c04fd430c8\"\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Members immediately inherit all policies assigned to the group."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-group-members","__idx":5},"children":["List group members"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve all subjects within a group:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"GetGroupSubjects","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"remove-a-member-from-a-group","__idx":6},"children":["Remove a member from a group"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"RemoveSubjectFromSubjectGroup","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The removed subject immediately loses any permissions that were inherited through this group. Permissions granted directly to the subject (via other policies) are unaffected."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-group-permissions","__idx":7},"children":["View group permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See all policies currently assigned to a group:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"GetGroupPermissions","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-group","__idx":8},"children":["Delete a group"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"DeleteSubjectGroup","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deleting a group removes all members from the group and deletes all policies associated with the group's subject ID. Members lose any permissions they inherited from this group."]}]}]},"headings":[{"value":"Groups","id":"groups","depth":1},{"value":"When to use groups","id":"when-to-use-groups","depth":2},{"value":"List groups","id":"list-groups","depth":2},{"value":"Create a group","id":"create-a-group","depth":2},{"value":"Add members to a group","id":"add-members-to-a-group","depth":2},{"value":"List group members","id":"list-group-members","depth":2},{"value":"Remove a member from a group","id":"remove-a-member-from-a-group","depth":2},{"value":"View group permissions","id":"view-group-permissions","depth":2},{"value":"Delete a group","id":"delete-a-group","depth":2}],"frontmatter":{"title":"Groups","seo":{"title":"Groups"}},"lastModified":"2026-05-08T13:38:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/platform/iam/guides/groups","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}