User Search

openapi: 3.0.1 info: version: '0.0' title: Consumer User Search servers: - url: 'https://banno.com' tags: - name: User Search paths: '/a/consumer-user-search/api/v0/institutions/{institutionId}/users': get: tags: - User Search description: | Returns users matching the given query. To deal with large amounts of users being returned pagination can be achieved by utilizing the `limit` and `offset` query parameters as well as the `totalCount` returned. Requires the "View" permission for People security: - clientCredentials: [ https://jackhenry.com/consumer-user-search ] parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/userSearchResult' components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} schemas: userSearchResult: description: This returns a list of user as well as the total count of possible records that could be returned. type: object properties: users: type: array items: $ref: '#/components/schemas/user' totalCount: type: number description: total number of users matching query user: type: object properties: userId: type: string format: uuid userActive: type: boolean primaryInstitutionUsername: type: string primaryInstitutionId: type: string format: uuid firstName: type: string middleInitial: type: string lastName: type: string userAdded: type: string format: date-time userModified: type: string format: date-time email: type: string nullable: true format: email userVerified: type: boolean businessName: type: string nullable: true userType: type: string enum: - Business - Individual reviewInstitutionId: type: string nullable: true format: uuid middleName: type: string nullable: true mobilePhoneNumber: type: string nullable: true example: '+15555551234' pattern: '^\+[1-9]\d{1,14}$' maskedSsn: type: string nullable: true preferredName: type: string nullable: true employeeStatus: type: string nullable: true lastSeen: description: This is the last time that the user has interacted with a Banno api. type: string format: date-time parameters: institutionId: in: path name: institutionId description: ID of an institution (must be a uuid) required: true schema: type: string query: in: query name: query description: Users are queryable by first name, last name, netteller id, email, preferred_name, or their username. required: true schema: type: string limit: in: query name: limit description: The max amount of users that will be returned at a given time required: false schema: type: integer default: 200 offset: in: query name: offset description: The number of users to skip required: false schema: type: integer default: 0