Differential D8142 Diff 29410 docs/api/register-account.rst

Changeset View

Standalone View

docs/api/register-account.rst

This file was added.

				.. _swh-deposit-register-account:
				anlambertUnsubmitted Done Inline Actions I would prefix the reference by `swh-deposit` here to avoid name clashes when compiling the whole swh doc. anlambert: I would prefix the reference by `swh-deposit` here to avoid name clashes when compiling the…
				ardumontAuthorUnsubmitted Done Inline Actions yes, i was wondering as well, i'll adapt. ardumont: yes, i was wondering as well, i'll adapt.

				.. admonition:: Intended audience
				:class: important

				- deposit clients
				- sysadm staff members

				Register account
				================

				.. _swh-deposit-register-account-as-deposit-client:
				anlambertUnsubmitted Done Inline Actions swh-deposit-register-account-as-client anlambert: swh-deposit-register-account-as-client

				As a deposit client
				-------------------

				For this, as a client, you need to register an account on the swh keycloak `production
				<https://archive.softwareheritage.org/oidc/login/?next_path=https://archive.softwareheritage.org/>`_
				or `staging
				<https://webapp.staging.swh.network/oidc/login/?next_path=https://webapp.staging.swh.network/>`_
				instance.

				.. _swh-deposit-register-account-as-sysadm:

				As a sysadm
				-----------


				1. Retrieve the deposit client login (through email exchange or any other media).

				2. Require a :ref:`provider url <swh-deposit-provider-url-definition>` from the deposit
				client (through email exchange or any other media).

				3. Within the keycloak `production instance <https://auth.softwareheritage.org/auth/admin/SoftwareHeritage/console/#/realms/SoftwareHeritage>`_ or `staging
				instance <https://auth.softwareheritage.org/auth/admin/SoftwareHeritageStaging/console/#/realms/SoftwareHeritageStaging>`_, add the `swh.deposit.api` role to the deposit
				client login.

				4. Create an :ref:`associated deposit collection
				<swh-deposit-add-client-and-collection>` in the deposit instance.

				5. Create :ref:`a deposit client <swh-deposit-add-client-and-collection>` with the
				provider url in the deposit instance.

				6. To ensure everything is ok, ask the deposit client to check they can access at least
				the service document iri (authenticated).