Details

openapi: 3.0.0 info: version: '1.0.0' title: User Details servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: User Functions paths: '/users/{userId}': put: tags: - User Functions description: Updates a user's information. Only permissible updates currently are to 'email' and notification registration information. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.email.readwrite' parameters: - $ref: '#/components/parameters/userId' requestBody: content: application/json: schema: $ref: '#/components/schemas/updateUser' description: User update information required: true responses: '204': description: User was updated successfully '400': description: Missing or malformed JSON was sent get: tags: - User Functions description: | This endpoint supports being used with an Access Token from the Admin API with "View everything – users, messages, settings, and organizations and organization members" permission for Associated User. Return the user's information security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.profile.readonly' parameters: - $ref: '#/components/parameters/userId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/userInfo' '404': description: Not found patch: tags: - User Functions description: 'Updates a user''s information using the JSON merge PATCH (https://tools.ietf.org/html/rfc7396). Only the `preferredName` field is supported at this moment.' security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.preferredname.readwrite' parameters: - $ref: '#/components/parameters/userId' requestBody: content: application/json: schema: $ref: '#/components/schemas/patchUser' description: User update information required: true responses: '204': description: User was updated successfully '400': description: Missing or malformed JSON was sent content: application/json: schema: $ref: '#/components/schemas/patchUserError' '401': description: Invalid authentication '404': description: User not found '415': description: Only the `application/merge-patch+json` is supported '500': description: Internal server error components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration parameters: userId: in: path name: userId description: ID of the desired user required: true schema: type: string schemas: adminLevel: description: User's admin level in the Organization type: string enum: - Admin - Viewer - User status: description: A user's account standing within Banno type: string enum: - Active - Pending - Disabled - Reset - Dormant - Locked - PasswordExpired updateUser: type: object required: - email properties: email: type: string userType: type: string description: 'One of the following: Individual or Business. This field is deprecated and has no effect' enum: - Individual - Business deprecated: true firstName: type: string description: Required if userType is Individual middleName: type: string lastName: type: string description: Required if userType is Individual businessName: type: string description: Required if userType is Business phoneNumber: type: string adminLevel: $ref: '#/components/schemas/adminLevel' address: type: object required: - streetAddress - streetAddress2 - city - state - zip properties: streetAddress: type: string streetAddress2: type: string city: type: string state: type: string zip: type: string patchUser: type: object properties: preferredName: type: string pattern: '^[ -]{0,20}$' patchUserError: type: object required: - errorCode properties: errorCode: type: string description: The error code. In descending order of priority as detailed by the list below enum: - MalformedJson - MaximumSizeExceeded - DisallowedCharacters userAttribute: type: object description: A name/value pair describing the name and value of a user's attribute required: - name - value properties: name: type: string value: type: string example: name: "NetTeller Id" value: "123456789012" userInfo: type: object description: Basic object containing user information. required: - userId - id - loginId - userType - provider - institutionId - username - userVerified - userAddedDateTime - attributes - enrollmentType properties: userId: type: string format: uuid description: Identifier for the user in Banno systems. This should match the userId parameter input parameter. id: type: string loginId: type: string format: uuid description: Identifier for the login in Banno systems. This differs from the userId value, as users may have multiple logins. example: 50014a3f-30fc-4ec9-b3e3-7ad1770c9e12 memberNumber: type: string pattern: '[0-9]{1,10}' description: Member number from the institution. This does not need to be padded. example: "975929983" email: type: string format: email userType: type: string enum: - Individual - Business provider: type: string enum: - online_banking - core - netteller - symxchange firstName: type: string middleName: type: string lastName: type: string username: type: string businessName: type: string preferredName: type: string adminLevel: $ref: '#/components/schemas/adminLevel' address: type: object required: - streetAddress - streetAddress2 - city - state - zip properties: streetAddress: type: string streetAddress2: type: string streetAddress3: type: string streetAddress4: type: string city: type: string state: type: string zip: type: string phoneNumber: type: string userVerified: type: boolean lastEulaAcceptance: type: object required: - acceptedAt - eulaId - userId properties: acceptedAt: type: string eulaId: type: string userId: type: string userAddedDateTime: type: string format: date-time institutionId: type: string format: uuid attributes: type: array items: $ref: '#/components/schemas/userAttribute' description: User-specific attributes. This will either not exist, or will contain values for the attributes "NetTeller Id" and "Cash Management Id". example: [{"name": "NetTeller Id", "value": "73948719041" }, {"name": "Cash Management Id", "value": "1234567890" }] enrollmentType: type: string enum: - seeded - drafted - self_enrolled description: The method by which the user enrolled in Banno example: seeded uisId: type: string description: Identifier for the user in UIS. organization: type: object required: - organizationId - status - adminLevel properties: organizationId: type: string format: uuid status: $ref: '#/components/schemas/status' adminLevel: $ref: '#/components/schemas/adminLevel' alias: type: string

{ "preferredName": null }

{  "preferredName": "Husband" }

{}