Abilities

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Abilities description: Digital Core Exception Item Processing API - Management of a Financial Institution's Exception Item Processing contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Abilities description: APIs for user specific abilities in Exception Item Processing paths: /a/api/eip/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/abilities: get: operationId: GetAbilities tags: - Abilities summary: Get Abilities description: Retrieve the abilities for the specified user. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: A list of abilities content: application/json: schema: type: object description: Response containing ability key definitions and granted abilities. properties: keyDefinitions: type: object description: Definitions of ability key formats by domain. additionalProperties: type: object description: Defines how ability keys are structured for a specific domain. properties: keyFormat: type: object description: Structure of the ability key format. properties: separator: type: string description: Separator used between key segments. example: ':' segmentOrder: type: array description: Ordered list of segments that make up the key. items: type: string example: - exceptionSource - exceptionType - transactionType - accountType description: type: string example: 'Four segments: exceptionSource, exceptionType, transactionType, accountType.' segmentInfo: type: array description: Metadata describing each segment of the key. items: type: object description: Describes a single key segment. properties: name: type: string description: Segment name. example: exceptionSource description: type: string description: Description of the segment's meaning. example: The exception source (system or origin) of the exception. grantedAbilities: type: array description: List of granted abilities for the user. items: type: object description: Represents a single granted ability with scope and metadata. properties: ability: type: string description: Fully qualified ability key. example: eip:silverlake_nsf:*:*:*:view domain: type: string description: Domain of the ability. example: eip actionId: type: string description: Identifier of the action. example: view actionLabel: type: string description: Label for the action. example: View Exception scopeKey: type: string description: Scope portion of the ability key. example: silverlake_nsf:*:*:* scopeLabel: type: string description: Label for the scope. example: NSF (all) example: keyDefinitions: eip: keyFormat: separator: ':' segmentOrder: - exceptionSource - exceptionType - transactionType - accountType description: 'Four segments: exceptionSource, exceptionType, transactionType, accountType.' segmentInfo: - name: exceptionSource description: The exception source (system or origin) of the exception. - name: exceptionType description: The exception type (kind of exception) within that source. - name: transactionType description: The transaction type of the exception. - name: accountType description: The account type associated with the exception. grantedAbilities: - ability: eip:silverlake_nsf:*:*:*:view domain: eip actionId: view actionLabel: View Exception scopeKey: silverlake_nsf:*:*:* scopeLabel: NSF (all) '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field