Roles API

openapi: 3.0.0 info: version: v1 title: Roles API description: '' contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-AMS-Operations@jackhenry.com security: - OAuth2: [] paths: /v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/jha-ams/authorizations/roles: post: tags: - Roles API description: Roles `Create` operationId: roles-create parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string ETag: description: >- Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json content: application/json: schema: type: object properties: RoleID: type: string description: Role ID readOnly: true MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesCreateResponse '204': description: >- Created, No Content<hr> There is no content to send for this request, but the headers may be useful. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string get: tags: - Roles API description: Roles `List` operationId: roles-list parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch - name: If-Modified-Since in: header description: >- Indicates the time for which a downloaded of a resource. Determine whether the resource has changed or not, since the last time it was accessed. schema: type: string example: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT - name: Offset in: query description: The service offset provided by the API provider schema: type: string - name: Count in: query description: >- The count of records requested <br>Example: `.../resource?Count=value` schema: type: string default: '0' responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role description: Array of Roles Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesListResponse '304': description: Not Modified headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string /v2/{InstitutionUniversalId}/jha-ams/authorizations/v1/roles: post: tags: - Roles API description: Roles `Create` operationId: roles-create-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string ETag: description: >- Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json content: application/json: schema: type: object properties: RoleID: type: string description: Role ID readOnly: true MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesCreateResponse '204': description: >- Created, No Content<hr> There is no content to send for this request, but the headers may be useful. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string get: tags: - Roles API description: Roles `List` operationId: roles-list-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch - name: If-Modified-Since in: header description: >- Indicates the time for which a downloaded of a resource. Determine whether the resource has changed or not, since the last time it was accessed. schema: type: string example: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT - name: Offset in: query description: The service offset provided by the API provider schema: type: string - name: Count in: query description: >- The count of records requested <br>Example: `.../resource?Count=value` schema: type: string default: '0' responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role description: Array of Roles Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesListResponse '304': description: Not Modified headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string /v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/jha-ams/authorizations/roles/{RoleId}: get: tags: - Roles API description: Roles `Inquiry` operationId: roles-inquire parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Fields in: query description: >- The query of fields, comma separated, for get operations. <br>Example: `.../resource?Fields=field1,field2,field3` schema: type: string example: field1,field2,field3 - name: Restrictions in: query description: >- The query of restrictions <br>Example: `.../resource?Restrictions=value` schema: type: boolean example: true - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch - name: If-Modified-Since in: header description: >- Indicates the time for which a downloaded of a resource. Determine whether the resource has changed or not, since the last time it was accessed. schema: type: string example: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string ETag: description: >- Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesInquireResponse '304': description: Not Modified headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string put: tags: - Roles API description: Roles `Replace` operationId: roles-replace parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role additionalProperties: false description: RolesReplaceRequest responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesReplaceResponse '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '412': description: >- Precondition Failed<hr> Resources has been updated since last time it was retrieved. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string delete: tags: - Roles API description: Roles `Delete` operationId: roles-delete parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesDeleteResponse '204': description: >- No Content<hr> There is no content to send for this request, but the headers may be useful. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '412': description: >- Precondition Failed<hr> Resources has been updated since last time it was retrieved. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string /v2/{InstitutionUniversalId}/jha-ams/authorizations/v1/roles/{RoleId}: get: tags: - Roles API description: Roles `Inquiry` operationId: roles-inquire-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Fields in: query description: >- The query of fields, comma separated, for get operations. <br>Example: `.../resource?Fields=field1,field2,field3` schema: type: string example: field1,field2,field3 - name: Restrictions in: query description: >- The query of restrictions <br>Example: `.../resource?Restrictions=value` schema: type: boolean example: true - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch - name: If-Modified-Since in: header description: >- Indicates the time for which a downloaded of a resource. Determine whether the resource has changed or not, since the last time it was accessed. schema: type: string example: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string ETag: description: >- Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesInquireResponse '304': description: Not Modified headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string put: tags: - Roles API description: Roles `Replace` operationId: roles-replace-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role additionalProperties: false description: RolesReplaceRequest responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesReplaceResponse '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '412': description: >- Precondition Failed<hr> Resources has been updated since last time it was retrieved. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string delete: tags: - Roles API description: Roles `Delete` operationId: roles-delete-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesDeleteResponse '204': description: >- No Content<hr> There is no content to send for this request, but the headers may be useful. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '412': description: >- Precondition Failed<hr> Resources has been updated since last time it was retrieved. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string /v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/jha-ams/authorizations/roles-search: post: tags: - Roles API description: Roles `Search` operationId: roles-search parameters: - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789` required: true schema: type: string default: '' - name: EnvironmentId in: path description: >- Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Offset in: query description: The service offset provided by the API provider schema: type: string - name: Count in: query description: >- The count of records requested <br>Example: `.../resource?Count=value` schema: type: string default: '0' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: Name: type: string description: Role Name additionalProperties: false description: RolesSearchRequest responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesSearchResponse '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string /v2/{InstitutionUniversalId}/jha-ams/authorizations/v1/roles-search: post: tags: - Roles API description: Roles `Search` operationId: roles-search-UIID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>` schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>` required: true schema: type: string example: jwt:<GeneratedOidcJwt> - name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: 'false' - name: Offset in: query description: The service offset provided by the API provider schema: type: string - name: Count in: query description: >- The count of records requested <br>Example: `.../resource?Count=value` schema: type: string default: '0' - name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch requestBody: content: application/json: schema: type: object properties: Name: type: string description: Role Name additionalProperties: false description: RolesSearchRequest responses: '200': description: >- OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: >- `MessageStatus` is required/expected for non 2xx responses. properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: >- The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesSearchResponse '400': description: >- Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string '401': description: >- Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: >- Forbidden<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: >- Not Found<hr> 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. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '413': description: >- Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '422': description: >- Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string default: description: >- Generic Internal Error<hr> The server has encountered a situation it does not know how to handle. content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: >- The key related to a log entry specific to the log store type: string tags: - name: Roles API description: Roles OpenAPI Definitions servers: - url: https://{API_ENVIRONMENT}/jx-api variables: API_ENVIRONMENT: default: jxdmz.jackhenry.com description: Corporate Test Server - url: https://{API_ENVIRONMENT}/jx-api variables: API_ENVIRONMENT: default: jxdmz.jackhenry.com description: 'Local Mock Server #1' - url: https://{API_ENVIRONMENT}/jx-api variables: API_ENVIRONMENT: default: jxdmz.jackhenry.com description: 'Local Mock Server #2' components: securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: >- https://jxdmz.jackhenry.com/jxchange/identity/authserver/connect/token scopes: {} parameters: pFields: name: Fields in: query description: >- The query of fields, comma separated, for get operations. <br>Example: `.../resource?Fields=field1,field2,field3` schema: type: string example: field1,field2,field3 pRestrictions: name: Restrictions in: query description: 'The query of restrictions <br>Example: `.../resource?Restrictions=value`' schema: type: boolean example: true pRbacPermissionID: name: RbacPermissionID in: path description: 'Custom URL key: PermissionID' required: true schema: type: string pAclPermissionID: name: AclPermissionID in: path description: 'Custom URL key: PermissionID' required: true schema: type: string pEntitlementID: name: EntitlementID in: path description: 'Custom URL key: EntitlementID' required: true schema: type: string ptags: name: tags in: query description: 'Custom query key: tags <br>Example: `.../resource?tags=value`' required: false schema: type: string psorID: name: sorID in: query description: >- Custom query key: sorID. The Source of Record for authorization information <br>Example: `.../resource?sorID=value` required: false schema: type: string pX-ent-path: name: X-ent-path in: header description: 'Custom header: X-ent-path' required: true schema: type: string pX-ent-data: name: X-ent-data in: header description: 'Custom header: X-ent-data' required: true schema: type: string pvariant_check: name: variant_check in: query description: >- Custom query key: variantcheck <br>Example: `.../resource?variantcheck=value` required: false schema: type: string pEntitlementName: name: EntitlementName in: query description: >- Custom query key: entitlementname <br>Example: `.../resource?entitlementname=name` required: false schema: type: string pRoleId: name: RoleId in: path description: 'Custom URL key: RoleId' required: true schema: type: string pPermissionSetID: name: PermissionSetID in: path description: 'Custom URL key: PermissionSetID' required: true schema: type: string pPermissionID: name: PermissionID in: path description: 'Custom URL key: PermissionID' required: true schema: type: string pRBACPermissionID: name: RBACPermissionID in: path description: 'Custom URL key: RBACPermissionID' required: true schema: type: string pTreeID: name: TreeID in: path description: 'Custom URL key: TreeID' required: true schema: type: string pDefinitionID: name: DefinitionID in: path description: 'Custom URL key: DefinitionID' required: true schema: type: string ppermissions: name: permissions in: query description: >- Custom query key: permissions <br>Example: `.../resource?permissions=value` required: false schema: type: string proles: name: roles in: query description: 'Custom query key: roles <br>Example: `.../resource?roles=value`' required: false schema: type: string pname: name: name in: query description: 'Custom query key: name <br>Example: `.../resource?name=value`' required: false schema: type: string pathSORId: name: SORId in: path description: 'Custom URL key: SORId' required: true schema: type: string pTreeName: name: TreeName in: path description: 'Custom URL key: TreeName' required: true schema: type: string requestBodies: EntEvaluationValuesSearchRequest: content: application/json: schema: type: object properties: EntitlementName: type: string description: Entitlement Name EntitlementValue: type: string description: Value of entitlement Node: type: string description: Child node value to return additionalProperties: false description: EntEvaluationsSearchRequest RolesCreateRequest: content: application/json: schema: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role RolesReplaceRequest: content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role additionalProperties: false description: RolesReplaceRequest RolesUpdateRequest: content: application/json: schema: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role NullElements: type: array items: type: string additionalProperties: false description: RolesUpdateRequest RolesSearchRequest: content: application/json: schema: type: object properties: Name: type: string description: Role Name additionalProperties: false description: RolesSearchRequest PermissionSetsCreateRequest: content: application/json: schema: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet PermissionSetsReplaceRequest: content: application/json: schema: type: object properties: PermissionSet: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet additionalProperties: false description: PermissionSetsReplaceRequest PermissionSetsUpdateRequest: content: application/json: schema: type: object properties: PermissionSet: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet NullElements: type: array items: type: string additionalProperties: false description: PermissionSetsUpdateRequest PermissionSetsSearchRequest: content: application/json: schema: type: object properties: Name: type: string description: Permission set Name additionalProperties: false description: PermissionSetsSearchRequest RbacPermissionsCreateRequest: content: application/json: schema: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission RbacPermissionsReplaceRequest: content: application/json: schema: type: object properties: Permission: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission additionalProperties: false description: RbacPermissionsReplaceRequest RbacPermissionsUpdateRequest: content: application/json: schema: type: object properties: Permission: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission NullElements: type: array items: type: string additionalProperties: false description: RbacPermissionsUpdateRequest RbacPermissionsSearchRequest: content: application/json: schema: type: object properties: Name: type: string description: Permission Name additionalProperties: false description: PermissionsSearchRequest AclPermissionsCreateRequest: content: application/json: schema: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission additionalProperties: false AclPermissionsReplaceRequest: content: application/json: schema: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission additionalProperties: false description: AclPermissionsReplaceRequest AclPermissionsUpdateRequest: content: application/json: schema: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission NullElements: type: array items: type: string additionalProperties: false description: AclPermissionsUpdateRequest AclPermissionsSearchRequest: content: application/json: schema: type: object properties: Name: type: string description: Permission Name Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer additionalProperties: false description: AclPermissionsSearchRequest EntAggregatesCreateRequest: content: application/json: schema: type: object properties: EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string example: CanSendWires Operation: description: ENUM[Add,Sub,Set] Operation to perform type: string example: Add, Sub, Set Value: type: number description: Value to use for operation UpdateChildNodes: type: string description: Update all matching entitlement values in child nodes EntEntitlementsCreateRequest: content: application/json: schema: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' EntEntitlementsReplaceRequest: content: application/json: schema: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' EntEntitlementsUpdateRequest: content: application/json: schema: type: object properties: Entitlement: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' NullElements: type: array items: type: string additionalProperties: false description: EntEntitlementsUpdateRequest EntEntitlementsSearchRequest: content: application/json: schema: type: object properties: EntitlementName: type: string description: Entitlement Name additionalProperties: false description: EntEntitlementsSearchRequest EntTreesCreateRequest: content: application/json: schema: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string EntTreesReplaceRequest: content: application/json: schema: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string EntTreesUpdateRequest: content: application/json: schema: type: object properties: EntitlementTree: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string NullElements: type: array items: type: string additionalProperties: false description: EntTreesUpdateRequest EntTreesSearchRequest: content: application/json: schema: type: object properties: TreeName: type: string description: Tree Name additionalProperties: false description: EntTreesSearchRequest EntDefinitionsCreateRequest: content: application/json: schema: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string EntDefinitionsReplaceRequest: content: application/json: schema: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string EntDefinitionsUpdateRequest: content: application/json: schema: type: object properties: EntitlementDefinition: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: >- An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: >- The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: >- The Tree ID -TreeId- this entitlement definition is related. type: string NullElements: type: array items: type: string additionalProperties: false description: EntDefinitionsUpdateRequest EntDefinitionsSearchRequest: content: application/json: schema: type: object properties: EntitlementName: type: string description: Entitlement Name additionalProperties: false description: EntDefinitionsSearchRequest schemas: RbacEvaluationsListResponse: type: object properties: RbacPermissions: type: array items: type: object properties: RbacPermissionId: type: string description: RBAC Permission Identifier PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description PermissionValue: type: string description: ENUM[allow,deny] Value of the permission additionalProperties: false description: Permission Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RbacEvaluationsListResponse RbacEvaluationsInquireResponse: type: object properties: RbacPermission: type: object properties: RbacPermissionId: type: string description: RBAC Permission Identifier PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description PermissionValue: type: string description: ENUM[allow,deny] Value of the permission additionalProperties: false description: Permission MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RbacEvaluationsInquireResponse AclEvaluationsListResponse: type: object properties: AclResources: type: array items: type: object properties: AclResourceId: type: string description: ACL Resource Permission Identifier ResourcePath: type: string description: Resource Path example: SilverLake.Customer PermissionValues: type: array items: type: string description: ENUM[create,read,update,delete,deny] Value of the permission TenantId: type: string additionalProperties: false description: AclEffectivePermission Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclEvaluationsListResponse AclEvaluationsInquireResponse: type: object properties: AclResource: type: object properties: AclResourceId: type: string description: ACL Resource Permission Identifier ResourcePath: type: string description: Resource Path example: SilverLake.Customer PermissionValues: type: array items: type: string description: ENUM[create,read,update,delete,deny] Value of the permission TenantId: type: string additionalProperties: false description: AclEffectivePermission MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclEvaluationsInquireResponse EntEvaluationsInquireResponse: type: object properties: Evaluation: type: object properties: EntitlementId: description: Entitlement identifier type: string EntitlementName: description: Entitlement name type: string Path: description: Entitlement path type: string Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'org':'MyOrg','user':'userid@domain.com' Values: type: array items: type: string AggregateValue: description: Aggregate (used) value of entitlement type: string Actionable: type: boolean MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string EntEvaluationsListResponse: type: object properties: Evaluations: type: array items: type: object properties: EntitlementId: description: Entitlement identifier type: string EntitlementName: description: Entitlement name type: string Path: description: Entitlement path type: string Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'org':'MyOrg','user':'userid@domain.com' Values: type: array items: type: string AggregateValue: description: Aggregate (used) value of entitlement type: string Actionable: type: boolean Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEvaluationsListResponse EntEvaluationValuesSearchRequest: type: object properties: EntitlementName: type: string description: Entitlement Name EntitlementValue: type: string description: Value of entitlement Node: type: string description: Child node value to return additionalProperties: false description: EntEvaluationsSearchRequest EntEvaluationValuesSearchResponse: type: object properties: Elements: type: array items: type: string Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsSearchResponse RolesCreateRequest: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role RolesCreateResponse: type: object properties: RoleID: type: string description: Role ID readOnly: true MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesCreateResponse RolesListResponse: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role description: Array of Roles Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesListResponse RolesInquireResponse: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesInquireResponse RolesReplaceRequest: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role additionalProperties: false description: RolesReplaceRequest RolesReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesReplaceResponse RolesUpdateRequest: type: object properties: Role: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id readOnly: true PermissionSetName: type: string description: PermissionSet Name example: Wires Teller readOnly: true PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller readOnly: true additionalProperties: false description: PermissionSetView description: Array of Permission Sets associated with Role additionalProperties: false description: Role NullElements: type: array items: type: string additionalProperties: false description: RolesUpdateRequest RolesUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesUpdateResponse RolesDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesDeleteResponse RolesSearchRequest: type: object properties: Name: type: string description: Role Name additionalProperties: false description: RolesSearchRequest RolesSearchResponse: type: object properties: Roles: type: array items: type: object properties: RoleId: type: string description: Role Identifier readOnly: true RoleName: type: string description: Role Name example: AddWireRole RoleDescription: maxLength: 300 type: string description: Role Description example: Add Wire Role additionalProperties: false description: Role Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RolesSearchResponse PermissionSetsCreateRequest: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet PermissionSetsCreateResponse: type: object properties: PermissionSetID: type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsCreateResponse PermissionSetsListResponse: type: object properties: PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller additionalProperties: false description: PermissionSet Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsListResponse PermissionSetsInquireResponse: type: object properties: PermissionSet: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsInquireResponse PermissionSetsReplaceRequest: type: object properties: PermissionSet: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet additionalProperties: false description: PermissionSetsReplaceRequest PermissionSetsReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsReplaceResponse PermissionSetsUpdateRequest: type: object properties: PermissionSet: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller RbacPermissions: type: array items: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID PermissionName: type: string description: Permission Name readOnly: true PermissionDescription: type: string description: Description readOnly: true PermissionValue: type: string description: Value of the permission additionalProperties: false description: RbacPermissionView description: Array of Permissions within the PermissionSet AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] readOnly: true PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: AclPermissionView description: Array of Permissions within the PermissionSet additionalProperties: false description: PermissionSet NullElements: type: array items: type: string additionalProperties: false description: PermissionSetsUpdateRequest PermissionSetsUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsUpdateResponse PermissionSetsDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsDeleteResponse PermissionSetsSearchRequest: type: object properties: Name: type: string description: Permission set Name additionalProperties: false description: PermissionSetsSearchRequest PermissionSetsSearchResponse: type: object properties: PermissionSets: type: array items: type: object properties: PermissionSetId: type: string description: PermissionSet Identifier example: WiresTeller readOnly: true UserPermissionSetId: type: string example: jane@mycompany.com description: User PermissionSet Id PermissionSetName: type: string description: PermissionSet Name example: Wires Teller PermissionSetDescription: type: string description: PermissionSet Description example: Wires Teller additionalProperties: false description: PermissionSet Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionSetsSearchResponse RbacPermissionsCreateRequest: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission RbacPermissionsCreateResponse: type: object properties: RbacPermissionID: type: string description: RBAC Permission ID readOnly: true MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false RbacPermissionsListResponse: type: object properties: Permissions: type: array items: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false RbacPermissionsInquireResponse: type: object properties: Permission: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsInquireResponse RbacPermissionsReplaceRequest: type: object properties: Permission: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission additionalProperties: false description: RbacPermissionsReplaceRequest RbacPermissionsReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: RbacPermissionsReplaceResponse RbacPermissionsUpdateRequest: type: object properties: Permission: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission NullElements: type: array items: type: string additionalProperties: false description: RbacPermissionsUpdateRequest RbacPermissionsUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsUpdateResponse RbacPermissionsDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsDeleteResponse RbacPermissionsSearchRequest: type: object properties: Name: type: string description: Permission Name additionalProperties: false description: PermissionsSearchRequest RbacPermissionsSearchResponse: type: object properties: Permissions: type: array items: type: object properties: RbacPermissionId: type: string description: Permission Identifier readOnly: true PermissionName: type: string description: Permission Name PermissionDescription: type: string description: Description SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires readOnly: true additionalProperties: false description: RbacPermission Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsSearchResponse AclPermissionsCreateRequest: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission additionalProperties: false AclPermissionsCreateResponse: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false AclPermissionsListResponse: type: object properties: AclPermissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclPermissionsListResponse AclPermissionsInquireResponse: type: object properties: AclPermission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclPermissionsInquireResponse AclPermissionsReplaceRequest: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission additionalProperties: false description: AclPermissionsReplaceRequest AclPermissionsReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclPermissionsReplaceResponse AclPermissionsUpdateRequest: type: object properties: Permission: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission NullElements: type: array items: type: string additionalProperties: false description: AclPermissionsUpdateRequest AclPermissionsUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclPermissionsUpdateResponse AclPermissionsDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsDeleteResponse AclPermissionsSearchRequest: type: object properties: Name: type: string description: Permission Name Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer additionalProperties: false description: AclPermissionsSearchRequest AclPermissionsSearchResponse: type: object properties: Permissions: type: array items: type: object properties: AclPermissionID: type: string description: ACL Permission ID readOnly: true ResourcePath: type: string description: Resource Path example: >- [SilverLake.Customer, SilverLake.Customer.Account, Wires.Customer.PersonName] PermissionValue: type: string description: Value of the permission SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires additionalProperties: false description: AclPermission Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: AclPermissionsSearchResponse EntAggregatesCreateRequest: type: object properties: EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string example: CanSendWires Operation: description: ENUM[Add,Sub,Set] Operation to perform type: string example: Add, Sub, Set Value: type: number description: Value to use for operation UpdateChildNodes: type: string description: Update all matching entitlement values in child nodes EntAggregatesCreateResponse: type: object properties: AggregateValue: description: Updated Aggregate value type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntAggregatesCreateResponse EntEntitlementsCreateRequest: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' EntEntitlementsCreateResponse: type: object properties: EntitlementId: description: Entitlement identifier type: string example: '{guid}' MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsCreateResponse EntEntitlementsListResponse: type: object properties: Entitlements: type: array items: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsListResponse EntEntitlementsInquireResponse: type: object properties: Entitlement: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsInquireResponse EntEntitlementsReplaceRequest: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' EntEntitlementsReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsReplaceResponse EntEntitlementsUpdateRequest: type: object properties: Entitlement: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' NullElements: type: array items: type: string additionalProperties: false description: EntEntitlementsUpdateRequest EntEntitlementsUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsUpdateResponse EntEntitlementsDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsDeleteResponse EntEntitlementsSearchRequest: type: object properties: EntitlementName: type: string description: Entitlement Name additionalProperties: false description: EntEntitlementsSearchRequest EntEntitlementsSearchResponse: type: object properties: Entitlements: type: array items: type: object properties: EntitlementId: description: >- Entitlement Identifier<br> - typically a guid assigned by the AMS when the entitlement is created. type: string readOnly: true example: '{guid}' DefinitionId: description: >- Entitlement Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>Must match an existing Entitlement definition by this name. type: string readOnly: true example: CanSendWires Path: description: Entitlement path type: string example: /jha-wires/wire-tree/org/user Elements: type: object additionalProperties: type: string description: >- Name:Value pairs of strings. Example: 'sorid':'jha-wires','treeid':'wire-tree','org':'MyOrg','user':'userid@domain.com' Value: type: array items: type: string description: >- The actual value for this instance of the entitlement. The value is converted to a string for storage. example: 'true' Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntEntitlementsSearchResponse EntTreesCreateRequest: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string EntTreesCreateResponse: type: object properties: TreeId: description: Tree identifier type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesCreateResponse EntTreesListResponse: type: object properties: Trees: type: array items: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesListResponse EntTreesInquireResponse: type: object properties: Tree: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesInquireResponse EntTreesReplaceRequest: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string EntTreesReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesReplaceResponse EntTreesUpdateRequest: type: object properties: EntitlementTree: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string NullElements: type: array items: type: string additionalProperties: false description: EntTreesUpdateRequest EntTreesUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesUpdateResponse EntTreesDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntTreesDeleteResponse EntTreesSearchRequest: type: object properties: TreeName: type: string description: Tree Name additionalProperties: false description: EntTreesSearchRequest EntTreesSearchResponse: type: object properties: EntitlementTrees: type: array items: type: object properties: SORId: description: >- SOR Id - This is the JHA Product ID that is the source-of-record for entitlements or authorizations. type: string example: jha-wires TreeId: description: Tree Identifier type: string readOnly: true TreeName: description: Tree name type: string AllPaths: type: array items: type: string Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: PermissionsSearchResponse EntDefinitionsCreateRequest: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string EntDefinitionsCreateResponse: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsCreateResponse EntDefinitionsListResponse: type: object properties: Definitions: type: array items: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsListResponse EntDefinitionsInquireResponse: type: object properties: Definition: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string EntDefinitionsReplaceRequest: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string EntDefinitionsReplaceResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsReplaceResponse EntDefinitionsUpdateRequest: type: object properties: EntitlementDefinition: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string NullElements: type: array items: type: string additionalProperties: false description: EntDefinitionsUpdateRequest EntDefinitionsUpdateResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsUpdateResponse EntDefinitionsDeleteResponse: type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsDeleteResponse EntDefinitionsSearchRequest: type: object properties: EntitlementName: type: string description: Entitlement Name additionalProperties: false description: EntDefinitionsSearchRequest EntDefinitionsSearchResponse: type: object properties: EntitlementDefinitions: type: array items: type: object properties: DefinitionId: description: >- Definition Identifier<br> - typically a guid assigned by the AMS when the entitlement definition is created. type: string readOnly: true example: '{guid}' EntitlementName: description: >- Entitlement name<br> - a name describing the entitlement and used to access the entitlement value. Should consider a Pascal case name scheme. <br>This name will be referenced when Entitlements are set. type: string Paths: description: An array of Tree paths where this entitlement could be set. type: array items: type: string example: - /jha-wires/wire-tree/org/user - /jha-wires/wire-tree/org/user/account Remote: description: OPTIONAL - Remote URL for entitlement type: string example: >- https://server.com/.../jha-productid/servicename/entitlement/{id} Crawl: description: How this Entitlement is evaluated. Straight or Sibling type: string example: Sibling DataType: description: Specifying the data type stored for this Entitlement. type: string example: string Calc: description: Calcuation of Entitlement specification. type: string example: SUM SORId: description: The Product ID -SORId- this entitlement definition is related. type: string example: jha-wires TreeId: description: The Tree ID -TreeId- this entitlement definition is related. type: string Paging: type: object properties: NextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string Results: description: The number of records sent for pagination type: integer Total: description: The total number of records requested for pagination type: integer MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false description: EntDefinitionsSearchResponse MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: >- The description related to the status code in a human readable format type: string MessageSource: description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: >- ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: >- The description related to the status code in a human readable format type: string Element: description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: >- This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string