{"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":"Onboard a Team","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":"onboard-a-team","__idx":0},"children":["Onboard a Team"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A finance team of five users needs read access to a specific subscription. You want to manage them as a unit so that adding or removing team members automatically adjusts their access."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Approach:"]}," Create a group, invite the users, add them to the group, then assign a single policy to the group."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An access token with IAM admin permissions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A configured tenant"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The scope URI for the subscription you want to grant access to"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-the-group","__idx":2},"children":["Step 1: Create the 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":["Note the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subjectId"]}," from the response — you will use it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]}," in the policy."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-invite-the-users","__idx":3},"children":["Step 2: Invite the users"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"InviteUserSubject","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Users become active subjects after they accept the invitation and complete registration. Repeat for each team member."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Tip"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your organization owns the email domain, you can ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/domains"},"children":["verify it"]}," and use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateUserSubject"]}," to add users instantly without waiting for invitation acceptance."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-add-users-to-the-group","__idx":4},"children":["Step 3: Add users to the group"]},{"$$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":["You can add multiple subject IDs in a single request."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-assign-a-policy-to-the-group","__idx":5},"children":["Step 4: Assign a policy to the group"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"CreatePolicy","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the group's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subjectId"]}," as the policy ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]},". All current and future members of the group inherit this policy immediately."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":6},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To add more users to the team later, use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/groups#add-members-to-a-group"},"children":["Add members to a group"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To revoke access for the entire team, delete the policy or ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/groups#delete-a-group"},"children":["delete the group"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To see what the group can currently do, use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/groups#view-group-permissions"},"children":["View group permissions"]}]}]}]},"headings":[{"value":"Onboard a Team","id":"onboard-a-team","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Step 1: Create the group","id":"step-1-create-the-group","depth":2},{"value":"Step 2: Invite the users","id":"step-2-invite-the-users","depth":2},{"value":"Step 3: Add users to the group","id":"step-3-add-users-to-the-group","depth":2},{"value":"Step 4: Assign a policy to the group","id":"step-4-assign-a-policy-to-the-group","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Onboard a Team","seo":{"title":"Onboard a Team"}},"lastModified":"2026-05-08T13:38:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/platform/iam/use-cases/onboard-team","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}