Admin

openapi: 3.0.0 info: version: "0.0" title: UIS Admin Endpoints servers: - url: 'https://banno.com' paths: "/a/uis/api/v0/institutions/{institutionId}/enrollment/start": post: tags: - UIS Enrollment description: > Generates a new enrollmentId to start enrollment. Enrollments expire in 1 hour. security: - OpenIDEnterprise: - https://jackhenry.com/uis/uis.enrollment parameters: - in: path name: institutionId description: ID for the institution. required: true schema: type: string requestBody: content: application/json: schema: type: object required: - clientId - productUserId properties: clientId: type: string description: Oauth client id for the client configured for the UIS product. UUID. example: "fdd343a1-2a7a-48b1-96a4-538210501ecd" productUserId: type: string description: This is a unique identifier for the user in the 3rd party product. username: type: string nullable: true email: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true homePhone: type: string description: E164 format example: "+15555551234" nullable: true mobilePhone: type: string description: E164 format example: "+15555551234" nullable: true workPhone: type: string description: E164 format example: "+15555551234" nullable: true workMobilePhone: type: string description: E164 format example: "+15555551234" nullable: true requiredSecurityLevel: type: string description: > The security level requested to set as the UIS user override. If the UIS institution default is more restrictive, we will ignore this value and have the user rely on the institution default for 2FA. example: 'high' enum: - 'standard' - 'enhanced' - 'high' nullable: true responses: "202": description: Successfully started enrollment "400": description: Missing or invalid enrollmentJWT "404": description: Invalid client ID "/a/uis/api/v0/institutions/{institutionId}/uis/users/{uisUserId}": get: tags: - UIS User Details description: > Get a UIS user's information security: - OpenIDEnterprise: - https://jackhenry.com/uis/users.read parameters: - in: path name: institutionId description: ID for the institution. required: true schema: type: string - in: path name: uisUserId description: ID of the UIS user required: true schema: type: string responses: "200": description: User was found. content: application/json: schema: $ref: '#/components/schemas/uisUser' "401": description: Invalid JWT "404": description: User not found "500": description: Internal Server Error components: securitySchemes: OpenIDEnterprise: $ref: 'https://jackhenry.dev/authentication-framework/security-schemes.swagger.yaml#/components/securitySchemes/OpenIDEnterprise' schemas: uisUser: type: object properties: productUserId: type: string description: Unique identifier for the user in the 3rd party product. firstName: type: string nullable: true lastName: type: string nullable: true email: type: string nullable: true username: type: string nullable: true

Please ignore this field