Skip to content

User

The user is the entity (Person) which is attached to an account, and will subscribe to the services offered by the Operator portal. A user, most likely, will be attached a web login, which will then allow to authenticate to Operator.

Properties of a user

  • * display name: The name that will be used to identify a user. Can be a nick name or any other identifier. This is most likely meant for the case when a user is an Application.
  • first name: First name of the user
  • prefix: Prefix of the user name, ex: Frenkie de Jong
  • last name: Last name of the user
  • * language code: The language the user is associated to. This is used to display the Operator portal in the language the user understands. Language code uses the language ISO 6391 plus the country ISO 3166-1 alpha-2. Ex: "nl-NL", "de-DE", "es-ES", etc.

The prefix * in the items listed above means they are mandatory.

Available features

  • List all users of an account
  • Add users to account
  • View details of user
  • Update details of user

Examples

List all users of an account
sequenceDiagram Actor->>Administration API: GET accounts owned by supplier Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation" Administration API-->>Actor: Use the account id of an specific account Actor->>Administration API: GET users that belong to the account selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/overviewUsingGET_6" "Swagger documentation" Administration API-->>Actor: OK!
Add users to account
sequenceDiagram Actor->>Administration API: GET accounts owned by supplier Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation" Administration API-->>Actor: Use the account id of an specific account Actor->>Administration API: Add user to the account selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/createUsingPOST_5" "Swagger documentation" Administration API-->>Actor: CREATED!
View details of user
sequenceDiagram Actor->>Administration API: GET users that belong to an account Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/overviewUsingGET_6" "Swagger documentation" Administration API-->>Actor: Use the user id of an specific user! Actor->>Administration API: View details of the user selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/detailsUsingGET_4" "Swagger documentation" Administration API-->>Actor: OK!
Update details of user
sequenceDiagram Actor->>Administration API: GET users that belong to an account Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/overviewUsingGET_6" "Swagger documentation" Administration API-->>Actor: Use the user id of an specific user! Actor->>Administration API: Update details of the user selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/user/updateUsingPUT_4" "Swagger documentation" Administration API-->>Actor: OK!