--- title: "Get Portal User" url: "https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/1237fe18-1f8f-477a-8f52-b3546dd409bf/operations/getUser" --- > Full API specification: https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/1237fe18-1f8f-477a-8f52-b3546dd409bf.md # Get Portal User `GET` `/portals/{portal-id}/users/{user-identifier}` Operation ID: `getUser` This endpoint enables the retrieval of user information from the portal utilizing the specific portalID based on UserId. Users need to confirm they have the required permissions before attempting to access this information. The operation helps in fetching critical user data for administrative or auditing purposes. You should have yukiapi:portal:users:read scope to access this endpoint. **Authorization** Called with a **Portal User** token - an employee of an accounting portal. The caller must hold at least one of these roles in the portal: `AccountantManagement`, `Accountant`. ## Path parameters - `portal-id` (string, required) - The portal id - `user-identifier` (string, required) - The user id ## Header parameters - `Authorization` (string, required) - Bearer token for authentication - `Content-Type` (string, required) - Content type of the request body ## Responses - `200` - Portal user object - `400` - Bad Request - `401` - Unauthorized - `403` - Forbidden - `404` - Not Found - `500` - Internal Server Error ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Yuki Platform API Prod version: 1.0.52 servers: - url: https://apirest.yukiworks.com/api/v1 paths: /portals/{portal-id}/users/{user-identifier}: get: x-environments: - development - pilot - production x-portal-visibility: - internal - trusted - prod x-required-roles: - any-of: - AccountantManagement - Accountant scope: portal summary: Get Portal User description: >- This endpoint enables the retrieval of user information from the portal utilizing the specific portalID based on UserId. Users need to confirm they have the required permissions before attempting to access this information. The operation helps in fetching critical user data for administrative or auditing purposes. You should have yukiapi:portal:users:read scope to access this endpoint. **Authorization** Called with a **Portal User** token - an employee of an accounting portal. The caller must hold at least one of these roles in the portal: `AccountantManagement`, `Accountant`. operationId: getUser tags: - Portal User parameters: - $ref: "#/components/parameters/AuthorizationHeader" - $ref: "#/components/parameters/ContentTypeHeader" - $ref: "#/components/parameters/PortalIdPath" - $ref: "#/components/parameters/GetUserIdPath" security: - vismaConnectPortalUser: - yukiapi:portal:users:read responses: "200": $ref: "#/components/responses/PortalUsersResponse" "400": $ref: "#/components/responses/BadRequestResponse" "401": $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" "404": $ref: "#/components/responses/NotFoundResponse" "500": $ref: "#/components/responses/InternalServerErrorResponse" security: - vismaConnectPortalUser: - yukiapi:portal:users:read components: parameters: AuthorizationHeader: name: Authorization in: header required: true description: Bearer token for authentication schema: type: string ContentTypeHeader: name: Content-Type in: header required: true description: Content type of the request body schema: type: string default: application/json PortalIdPath: name: portal-id in: path required: true description: The portal id example: 3afb7b54-6144-4561-9a29-1148006f2375 schema: type: string GetUserIdPath: name: user-identifier in: path required: true description: The user id example: 3afb7b54-6144-4561-9a29-1148006f2375 schema: type: string responses: PortalUsersResponse: description: Portal user object content: application/json: schema: $ref: "#/components/schemas/PortalUser" BadRequestResponse: description: Bad Request content: application/problem+json: schema: $ref: "#/components/schemas/BadRequestError" UnauthorizedResponse: description: Unauthorized content: application/problem+json: schema: $ref: "#/components/schemas/UnauthorizedError" ForbiddenResponse: description: Forbidden content: application/problem+json: schema: $ref: "#/components/schemas/ForbiddenError" NotFoundResponse: description: Not Found content: application/problem+json: schema: $ref: "#/components/schemas/NotFoundError" InternalServerErrorResponse: description: Internal Server Error content: application/problem+json: schema: $ref: "#/components/schemas/InternalServerError" schemas: PortalUser: type: object properties: id: type: string description: The user's ID example: 3afb7b54-6144-4561-9a29-1148006f2375 name: type: string description: Full name of the user example: John Doe email: type: string format: email description: User email example: john.doe@yuki.nl language: $ref: "#/components/schemas/Language" roles: $ref: "#/components/schemas/PortalUserRoles" BadRequestError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/bad-request title: Bad Request status: 400 detail: The request is invalid or malformed. instance: /example/bad-request UnauthorizedError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/unauthorized title: Unauthorized status: 401 detail: Authentication is required. instance: /example/unauthorized ForbiddenError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/forbidden title: Forbidden status: 403 detail: You do not have permission to access this resource. instance: /example/forbidden NotFoundError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/not-found title: Not Found status: 404 detail: The requested resource could not be found. instance: /example/not-found InternalServerError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/internal-server-error title: Internal Server Error status: 500 detail: An unexpected error occurred. instance: /example/internal-server-error Language: type: string enum: - nl-BE - en-US - fr-BE - nl-NL description: | The locale for the domain. \ BE: nl-BE, en-US, fr-BE. \ NL: en-US, nl-NL example: en-US PortalUserRoles: type: array description: User roles for portal users items: type: string enum: - PortalAdministrator - PortalBackoffice - PortalBackofficeController - PortalDataEntry ProblemDetails: type: object properties: type: type: string example: https://dev.yuki.nl/errors/problem title: type: string example: Problem status: type: integer example: 500 detail: type: string example: An unexpected error occurred. instance: type: string example: /example/endpoint securitySchemes: vismaConnectPortalUser: type: oauth2 description: > Visma Connect token belonging to a **Portal User** - an employee of an accounting portal. The token carries a `portal-id` claim, and the portal it identifies must match the portal in the route. Unless an endpoint says otherwise, the caller's roles are resolved against the portal. flows: authorizationCode: authorizationUrl: https://connect.identity.stagaws.visma.com/connect/authorize tokenUrl: https://connect.identity.stagaws.visma.com/connect/token scopes: yukiapi:domain:companies:read: Allows reading information of a Company yukiapi:domain:companies:update: Allows the update of a Company yukiapi:portal:portals:read: Allows reading portal information yukiapi:domain:domains:read: Allows reading domains information yukiapi:domain:domains:write: Allows modifications of domain information, may include create/update yukiapi:domain:domains:create: Allows the creation of new domains yukiapi:domain:domains:update: Allows updating existing domain information yukiapi:domain:domains:delete: Allows the deletion of domain data yukiapi:domain:users:read: Allows reading of domain user data yukiapi:domain:users:write: Allows the update of domain user data, may include create/update yukiapi:domain:users:update: Allows updating a Domain User yukiapi:domain:users:delete: Allows the deletion of Domain Users yukiapi:portal:portals:write: Allows updating existing portal information yukiapi:portal:users:read: Allows reading Portal user data yukiapi:portal:users:write: Allows the update of Portal user, may include create/update yukiapi:portal:users:update: Allows updating an existing Portal User yukiapi:portal:users:delete: Allows the deletion of a Portal User ```