iOS - Accounts and Access

To build the DevApp and develop a module, you need access to a small set of Q2-managed resources. Most are tied to your existing Q2 Developer Portal account — the only things you actively need to set up are a Personal Access Token and a sandbox environment URL.

What you need

Item	What it is	Who provides it
Q2 Developer Portal account	Where you read documentation, open support tickets, and submit modules for review.	Sign up at q2developer.com (most teams already have one).
Q2 GitLab access	A user account on code.q2developer.com so you can clone the DevApp and read Q2's libraries.	Comes with your Q2 Developer Portal account.
A GitLab group for your organization	The folder under code.q2developer.com where your modules live.	Created by Q2 — request via support ticket if your organization does not yet have one.
Personal Access Token (PAT)	A token Xcode uses to authenticate to Q2's private Swift Package registry.	You generate it from your GitLab profile.
Sandbox environment URL	The URL your DevApp points at when running locally (used as targetURLBase in settings.json).	Your Q2 representative.

1. Q2 Developer Portal account

The Q2 Developer Portal is the entry point for module development — reading docs, opening support tickets, and submitting modules for publishing review. If you reached this page, you almost certainly have a portal account; new teammates can sign up at q2developer.com themselves.

From the portal you can:

• Open a support ticket — q2developer.com/support/create. Use this to request a GitLab group, ask questions, report bugs, or submit modules for review.
• View your existing tickets — q2developer.com/support.

2. Confirm GitLab access

Your portal account automatically grants access to Q2's GitLab at code.q2developer.com. To confirm, sign in and load the DevApp repository: code.q2developer.com/Q2Antilles/native/ios/devapp-ios.

If the page loads, you are set. If it returns "404 Not Found" or "Sign in", open a portal support ticket and our team will link your accounts.

Does your organization have a GitLab group?

Each organization gets its own group under code.q2developer.com — that is where your module repositories live once you start publishing. If your organization is new to Q2 and does not yet have one, open a support ticket at q2developer.com/support/create with:

• Your organization name.
• The full names and work emails of the developers who need access.
• The name of the module(s) your team plans to build.

You can clone the DevApp and start development before the group exists — it is only required when you are ready to push your own module repository.

3. Generate a Personal Access Token

Xcode will fail to resolve Q2's Swift packages with an authentication error if no token is configured. The token authenticates your machine against Q2's private Swift Package registry hosted on code.q2developer.com.

Steps to generate a token

1. Go to https://code.q2developer.com.
2. Click your user icon (top-right) → Edit profile → Access Tokens.
3. Click Add new token.
4. Fill in the form:
   • Token name: Anything descriptive — for example, iOS DevApp.
   • Expiration date: Pick a date inside your organization's policy. Tokens cannot have unlimited lifetime.
   • Scopes: Enable api, read_api, read_registry, and read_repository.
5. Click Create personal access token.
6. Copy the token immediately. GitLab only shows it once — if you navigate away without copying, you must generate a new one.

Configure Xcode to use the token

Xcode must be told about code.q2developer.com before it can resolve Q2's Swift packages.

1. Open Xcode → Settings → Source Control → Accounts.
2. Click + and select GitLab (Self-Hosted).
3. Fill in the following:
   • Server: https://code.q2developer.com
   • Account: Your GitLab username (find it at code.q2developer.com/-/profile/account)
   • Token: Paste the token you generated above.
4. Click Sign In.
5. Restart Xcode, then choose File → Packages → Reset Package Caches.

Xcode will now authenticate automatically when resolving Q2's Swift packages.

Keep tokens out of public surfaces

Your token only grants access to repositories you already have access to — but it is still a personal credential. Avoid pasting it into chat, screenshots, or public repositories. If a token is exposed outside your organization, revoke it from Edit profile → Access Tokens in GitLab and generate a new one.

4. Obtain your sandbox environment URL

Your DevApp's settings.json has a targetURLBase field that points at a Q2-hosted backend environment. For most teams, this is a sandbox or SDX environment your Q2 representative provides.

Example value (yours will differ):

https://stack.q2developer.com/sdk/native/<your-environment>

Without this URL, the DevApp runs but cannot communicate with a backend — login, account data, and most user-facing features will not work.

If you have not been given a URL by the time you reach the settings.json setup step, request one from your Q2 representative or open a portal support ticket.

What's next

Token copied, sandbox URL in hand, and GitLab access confirmed? Move on to the Pre-Development Checklist to confirm everything is in place before you clone the DevApp.