REST API URI format - CustomerID

Owned by John Jellema
2021-12-17
1 min read

Base URI is a prefix for all URIs describing a collection or entity. Each collection is assigned a static base constructed from the base URI. Each entity has a dynamic URI constructed from the base URI.
Note that there are two main REST endpoints: /eidm2/services and /customerid-rest/services. The latter one is also extended with version specific endpoints.

Base URIs

  • https://HOSTNAME/eidm2/services/
  • https://HOSTNAME/customerid-rest/services/
  • https://HOSTNAME/customerid-rest/services/2.0/
  • https://HOSTNAME/customerid-rest/services/2.1/

Entity URIs

  • https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME
  • https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME
  • https://HOSTNAME/customerid-rest/services/pendinguser/USERID
  • https://HOSTNAME/customerid-rest/services/roleinvitation/ROLEINVITATIONID
  • https://HOSTNAME/customerid-rest/services/user/USERID
  • https://HOSTNAME/eidm2/services/init/
  • https://HOSTNAME/eidm2/services/logger/diag
  • https://HOSTNAME/eidm2/services/org/ENTITYNAME
  • https://HOSTNAME/eidm2/services/role/ENTITYNAME
  • https://HOSTNAME/eidm2/services/user/ENTITYNAME

Collection URIs

  • https://HOSTNAME/customerid-rest/services/delegations/
  • https://HOSTNAME/customerid-rest/services/mandates/
  • https://HOSTNAME/customerid-rest/services/mandatetemplates/
  • https://HOSTNAME/customerid-rest/services/pendingusers/
  • https://HOSTNAME/customerid-rest/services/roledelegations/
  • https://HOSTNAME/customerid-rest/services/roleinvitations/
  • https://HOSTNAME/eidm2/services/assignments/ENTITYNAME (Role Assignments. ENTITYNAME defines the role. Parameter defines the user.)
  • https://HOSTNAME/eidm2/services/orgs/
  • https://HOSTNAME/eidm2/services/roles/
  • https://HOSTNAME/eidm2/services/users/

Combined URIs

  • https://HOSTNAME/customerid-rest/services/2.0/users/ (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/users/USERID (Entity)
    • https://HOSTNAME/customerid-rest/services/2.0/users/USERID/roleinvitations (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/users/USERID/roles (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/users/USERID/givenmandates (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/users/USERID/receivedmandates (Collection)
  • https://HOSTNAME/customerid-rest/services/2.0/roles/ (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/roles/ROLEID (Entity)
    • https://HOSTNAME/customerid-rest/services/2.0/roles/ROLEID/users (Collection)
  • https://HOSTNAME/customerid-rest/services/2.0/workflows/ (Collection)
    • https://HOSTNAME/customerid-rest/services/2.0/workflows/WORKFLOWID (Entity)
    • https://HOSTNAME/customerid-rest/services/2.0/workflows/WORKFLOWID/users (Collection)

Ubisecure Privacy Policy & Cookie Statement