Sign in
Users

Get Authorized Uids

Retrieves all UIDs authorized for the currently authenticated data producer.

get/api/user/v1/authorized-uids

Query parameters

agate-login-idstring

The agateLoginId of the producer (only relevant for admin users)

kt-id-pstring

The kt-id-p identifier of the producer (only relevant for admin users)

actingRole'PRODUCER' | 'ADMIN' | 'SUPPORT'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

uidstring required
namestring
legalFormCode'NATUERLICHE_PERSON' | 'EINFACHE_GESELLSCHAFT' | 'KOLLEKTIVGESELLSCHAFT' | 'KOMMANDITGESELLSCHAFT' | 'KOMMANDITAKTIENGESELLSCHAFT' | 'AKTIENGESELLSCHAFT' | 'GMBH' | 'GENOSSENSCHAFT' | 'VEREIN' | 'STIFTUNG' | 'OEFF_RECHT_KOERPERSCHAFT_VERWALTUNG' | 'LANDESKIRCHE' | 'BUND' | 'KANTON' | 'BEZIRK' | 'GEMEINDE' | 'OEFF_RECHT_KOERPERSCHAFT_BETRIEB' | 'EQUIDENEIGENTUEMER' | 'UNKNOWN'

Changes

Changed in 10 of the 56 revisions of this API.1711

  • d1729646b7662See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

  • a598446f80932See the full diff
    • ○

      removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404

      response-property-enum-value-removed

    • ○

      removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cee7b14bf6f21See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ○

      added the new optional query request parameter actingRole

      new-optional-request-parameter

  • 5b038eea902d8See the full diff
    • ●

      added the new OTP_EXPIRED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_EXPIRED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500

      response-property-enum-value-added

  • 0d45567e16a82See the full diff
    • ●

      added the new CONSENT_NOT_GRANTED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new CONSENT_NOT_GRANTED enum value to the type response property for the response status 500

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1836059a633b13See the full diff
    • ●

      added the new EQUIDENEIGENTUEMER enum value to the items/legalFormCode response property for the response status 200

      response-property-enum-value-added

    • ○

      the security scope agridata.ch.Agridata_Admin was added to the endpoint's security scheme SecurityScheme

      api-security-scope-added

    • ○

      added the new optional query request parameter agate-login-id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter kt-id-p

      new-optional-request-parameter

  • 3026a580bab42See the full diff
    • ●

      added the new MAINTENANCE enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new MAINTENANCE enum value to the type response property for the response status 500

      response-property-enum-value-added

  • a2899b74ad131See the full diff
    • ○

      the response property items/uid became required for the status 200

      response-property-became-required

  • 1dcf6d02a6153See the full diff
    • ○

      the security scope agridata.ch.Agridata_Support was added to the endpoint's security scheme SecurityScheme

      api-security-scope-added

    • ○

      the response property requestId became required for the status 404

      response-property-became-required

    • ○

      the response property requestId became required for the status 500

      response-property-became-required

  • 34c19e697f581See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog