Partner Clients

openapi: 3.0.0 info: version: '0.0' title: Partner Clients tags: - name: Partner Clients servers: - url: 'https://banno.com' paths: '/a/oidc-provider/api/v0/institutions/{institutionId}/partner-clients/{partnerName}': get: tags: - Partner Clients description: | Returns the consumer clients created by a specific partner. Allows partners with direct legal agreements to manage OAuth clients they create. parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: partnerName description: partner name required: true schema: $ref: '#/components/schemas/validPartners' responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/partnerClientDetails' post: tags: - Partner Clients description: | Creates a Consumer Client for a specific partner. Allows partners with direct legal agreements to create OAuth clients dynamically parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: partnerName description: partner name required: true schema: $ref: '#/components/schemas/validPartners' requestBody: content: application/json: schema: $ref: '#/components/schemas/createPartnerClientDetails' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/createClientResponse' '/a/oidc-provider/api/v0/institutions/{institutionId}/partner-clients/{partnerName}/{clientId}': get: tags: - Partner Clients description: | Returns the specified consumer client created by a specific partner. Allows partners with direct legal agreements to manage OAuth clients they create. parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: partnerName description: partner name required: true schema: $ref: '#/components/schemas/validPartners' - in: path name: clientId description: Client ID required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/partnerClientDetails' '404': description: Not found put: tags: - Partner Clients description: | Updates a Consumer Client created by a specific partner. Allows partners with direct legal agreements to update OAuth clients they dynamically created parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: partnerName description: partner name required: true schema: $ref: '#/components/schemas/validPartners' - in: path name: clientId description: Client ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/updatePartnerClientDetails' responses: '204': description: Success '404': description: Not found delete: tags: - Partner Clients description: | Deletes a Consumer Client created by a specific partner. Allows partners with direct legal agreements to manage OAuth clients they dynamically created parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: partnerName description: partner name required: true schema: $ref: '#/components/schemas/validPartners' - in: path name: clientId description: Client ID required: true schema: type: string responses: '204': description: Success '404': description: Not found 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: createClientResponse: type: object properties: client: type: object properties: clientId: type: string clientSecret: type: string partnerClientDetails: type: object properties: clientId: example: 00000000-0000-0000-0000-000000000000 type: string name: example: Sample External App type: string redirectUris: type: array items: type: string example: ['https://domain.com/callback'] logoUri: example: https://domain.com/logo.png type: string clientUri: example: https://domain.com/ type: string policyUri: example: https://domain.com/privacy-policy.htm type: string tosUri: example: https://domain.com/terms-of-service.htm type: string contacts: example: - name1@domain.com - name2@domain.com type: array items: type: string pkceRequired: type: boolean createPartnerClientDetails: type: object required: - name - redirectUris properties: name: example: Sample External App type: string redirectUris: type: array items: type: string example: ['https://domain.com/callback'] logoUri: example: https://domain.com/logo.png type: string clientUri: example: https://domain.com/ type: string policyUri: example: https://domain.com/privacy-policy.htm type: string tosUri: example: https://domain.com/terms-of-service.htm type: string contacts: example: - name1@domain.com - name2@domain.com type: array items: type: string pkceRequired: type: boolean updatePartnerClientDetails: type: object properties: name: example: Sample External App type: string redirectUris: type: array items: type: string example: ['https://domain.com/callback'] logoUri: example: https://domain.com/logo.png type: string clientUri: example: https://domain.com/ type: string policyUri: example: https://domain.com/privacy-policy.htm type: string tosUri: example: https://domain.com/terms-of-service.htm type: string contacts: example: - name1@domain.com - name2@domain.com type: array items: type: string pkceRequired: type: boolean validPartners: type: string