Management API (HaaS)
Management API (HaaS) (1.36.0.0)
Download OpenAPI specification:Download
This is the OpenAPI specification consumed by Consumer Dashboard Clients
List Principal Accounts
List Principal Accounts for a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
| account-type | Array of strings (EnumDashboardRealmAccountTypeV1) Items Enum: "SINGLE" "JOINT" "BUSINESS" Example: account-type=SINGLE Filter on a specific Account Type (if not provided no filter will be applied) |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Get Specific Account
Get the details for a specific Account in the context of a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
}List Grants for Specific Account
List Grants related to a specific Account in the context of a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
| status | Array of strings (EnumGrantStatus) Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED" Example: status=ACTIVE Filter on a specific grant status |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "grantId": "f924e6a6-248b-4034-9885-25f8805964cd",
- "grantType": "CDR_SHARING_ARRANGEMENT_V1",
- "softwareProduct": {
- "softwareProductId": "01cd0bb0-0eb5-4e73-8c0d-dcbe7df27dc3",
- "productId": "d1b29ec9-ba9e-4ad7-aac3-7a4afa03fc7d",
- "name": "Test Software Product",
- "description": "This is an example of a software product's description",
- "status": "ACTIVE",
- "brandName": "Test Recipient Brand",
- "brandStatus": "ACTIVE",
- "accreditationNumber": "TESTACCNO000123"
}, - "status": "ACTIVE",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-02T12:30:00Z",
- "principalId": "e4ddb46f-ff94-42a4-bba3-0a36be4de5ee",
- "userId": "e56ffbdv-dd98-78d4-mn72-8v056786eed7",
- "accounts": {
- "accountID": "ee00456f-90ao-5609-nm67-6hjn900234yu",
- "accountType": "single"
}, - "scopes": {
- "name": "common:customer.basic:readd",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}, - "cx_scopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)",
- "includedScopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}
}, - "private": false
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Service Health Status
Retrieve health check summary
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
{- "data": {
- "status": "UP"
}
}List DOMS Requests for a specific Principal
Lists all DOMS requests related to the specific Principal
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| isCreator | boolean Filter DOMS requests by those created by this user |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "createdBy": "51af03f3-5583-4ba5-bd31-12064082eb25",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING",
- "responses": [
- {
- "respondedAt": "2022-06-01T10:30:00Z",
- "response": "PENDING",
- "userId": "51af03f3-5583-4ba5-bd31-12064082eb25"
}
]
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Get DOMS Request
Get a DOMS request by the request identifier
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| requestId required | string <uuid> ID of the specific sharing request |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "createdBy": "51af03f3-5583-4ba5-bd31-12064082eb25",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING",
- "responses": [
- {
- "respondedAt": "2022-06-01T10:30:00Z",
- "response": "PENDING",
- "userId": "51af03f3-5583-4ba5-bd31-12064082eb25"
}
]
}
}List DOMS Requests for a Specific Account
Lists all DOMS requests related to a specific Account for a specific Principal
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| isCreator | boolean Filter DOMS requests by those created by this user |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "createdBy": "51af03f3-5583-4ba5-bd31-12064082eb25",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING",
- "responses": [
- {
- "respondedAt": "2022-06-01T10:30:00Z",
- "response": "PENDING",
- "userId": "51af03f3-5583-4ba5-bd31-12064082eb25"
}
]
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Create DOMS Request for an Account for a specific User
Creates a DOMS change request for a specific Account from a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Request Body schema: application/jsonrequired
Create DOMS Request
required | object (CreateDOMSRequestV1) | ||||||||||
| |||||||||||
Responses
Request samples
- Payload
{- "data": {
- "action": "PRE_APPROVAL",
- "userId": "77bdf4ac-f107-4524-aa11-b15086ac1f35"
}
}Response samples
- 200
- 400
- 404
{- "data": [
- {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "createdBy": "51af03f3-5583-4ba5-bd31-12064082eb25",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING",
- "responses": [
- {
- "respondedAt": "2022-06-01T10:30:00Z",
- "response": "PENDING",
- "userId": "51af03f3-5583-4ba5-bd31-12064082eb25"
}
]
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Handle DOMS Request for an Account
Provides a method of responding to a DOMS request
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
| requestId required | string <uuid> ID of the specific sharing request |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Request Body schema: application/jsonrequired
required | object (UpdateDOMSRequestV1) | ||||
| |||||
Responses
Request samples
- Payload
{- "data": {
- "action": "APPROVED",
- "userId": "77bdf4ac-f107-4524-aa11-b15086ac1f35"
}
}Response samples
- 200
- 400
- 404
{- "data": [
- {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "createdBy": "51af03f3-5583-4ba5-bd31-12064082eb25",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING",
- "responses": [
- {
- "respondedAt": "2022-06-01T10:30:00Z",
- "response": "PENDING",
- "userId": "51af03f3-5583-4ba5-bd31-12064082eb25"
}
]
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}List Grants Deprecated
Lists Grants (Arrangements) for a specific User
Note: This endpoint is intended for eventual migration to /{principalId}/grant.
We recommend considering migrating to this alternative URL at your convenience but have not currently defined any retirement date.
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
| status | Array of strings (EnumGrantStatus) Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED" Example: status=ACTIVE Filter on a specific grant status |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "grantId": "f924e6a6-248b-4034-9885-25f8805964cd",
- "grantType": "CDR_SHARING_ARRANGEMENT_V1",
- "softwareProduct": {
- "softwareProductId": "01cd0bb0-0eb5-4e73-8c0d-dcbe7df27dc3",
- "productId": "d1b29ec9-ba9e-4ad7-aac3-7a4afa03fc7d",
- "name": "Test Software Product",
- "description": "This is an example of a software product's description",
- "status": "ACTIVE",
- "brandName": "Test Recipient Brand",
- "brandStatus": "ACTIVE",
- "accreditationNumber": "TESTACCNO000123"
}, - "status": "ACTIVE",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-02T12:30:00Z",
- "principalId": "e4ddb46f-ff94-42a4-bba3-0a36be4de5ee",
- "userId": "e56ffbdv-dd98-78d4-mn72-8v056786eed7",
- "accounts": {
- "accountID": "ee00456f-90ao-5609-nm67-6hjn900234yu",
- "accountType": "single"
}, - "scopes": {
- "name": "common:customer.basic:readd",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}, - "cx_scopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)",
- "includedScopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}
}, - "private": false
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}List Grants
Lists Grants (Arrangements) for a specific Principal in the context of a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
| status | Array of strings (EnumGrantStatus) Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED" Example: status=ACTIVE Filter on a specific grant status |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "grantId": "f924e6a6-248b-4034-9885-25f8805964cd",
- "grantType": "CDR_SHARING_ARRANGEMENT_V1",
- "softwareProduct": {
- "softwareProductId": "01cd0bb0-0eb5-4e73-8c0d-dcbe7df27dc3",
- "productId": "d1b29ec9-ba9e-4ad7-aac3-7a4afa03fc7d",
- "name": "Test Software Product",
- "description": "This is an example of a software product's description",
- "status": "ACTIVE",
- "brandName": "Test Recipient Brand",
- "brandStatus": "ACTIVE",
- "accreditationNumber": "TESTACCNO000123"
}, - "status": "ACTIVE",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-02T12:30:00Z",
- "principalId": "e4ddb46f-ff94-42a4-bba3-0a36be4de5ee",
- "userId": "e56ffbdv-dd98-78d4-mn72-8v056786eed7",
- "accounts": {
- "accountID": "ee00456f-90ao-5609-nm67-6hjn900234yu",
- "accountType": "single"
}, - "scopes": {
- "name": "common:customer.basic:readd",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}, - "cx_scopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)",
- "includedScopes": {
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
}
}, - "private": false
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Get Grant
Get details for a specific Grant
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "grantId": "f924e6a6-248b-4034-9885-25f8805964cd",
- "grantType": "CDR_SHARING_ARRANGEMENT_V1",
- "softwareProduct": {
- "softwareProductId": "01cd0bb0-0eb5-4e73-8c0d-dcbe7df27dc3",
- "productId": "d1b29ec9-ba9e-4ad7-aac3-7a4afa03fc7d",
- "name": "Test Software Product",
- "description": "This is an example of a software product's description",
- "status": "ACTIVE",
- "brandName": "Test Recipient Brand",
- "brandStatus": "ACTIVE",
- "accreditationNumber": "TESTACCNO000123",
- "id": "01cd0bb0-0eb5-4e73-8c0d-dcbe7df27dc3"
}, - "status": "ACTIVE",
- "created": "2021-01-01T12:30:00Z",
- "expiry": "2021-01-02T12:30:00Z",
- "principalId": "e4ddb46f-ff94-42a4-bba3-0a36be4de5ee",
- "userId": "2753c9cc-316f-42c1-97c8-4ae38d119fe2",
- "accounts": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE"
}
], - "scopes": [
- {
- "id": "c2b35192-ecff-4239-b07a-fa1563b2b150",
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": [
- "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
]
}
], - "cx_scopes": [
- {
- "id": "bank:payees:read",
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": [
- "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
], - "includedScopes": [
- {
- "id": "c2b35192-ecff-4239-b07a-fa1563b2b150",
- "name": "common:customer.basic:read",
- "description": "Saved payees",
- "permissionLanguage": [
- "Names and details of accounts you have saved (eg. their BSB and Account Number, BPay CRN and Biller code, or NPP PayID)"
]
}
]
}
], - "private": false,
- "latestTokenTime": "2021-01-01T15:30:00Z"
}Delete Grant
Revokes a specific Grant immediately triggering notification actions to related parties
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 400
- 404
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Invalid",
- "title": "Invalid Field",
- "detail": "Invalid format supplied for fieldName",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Invalid"
}
}
]
}List Grant Logs
Returns logs about every event that modifies this grant.
Examples are:
- Access token issuance (i.e: the ADR is requesting a data sharing session)
- Dashboard api modifications
- Amending consent with the user
- Revocation
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| eventType | Array of strings (EnumGrantEventTypeV1) Items Enum: "GRANT_ACCESS_TOKEN_ISSUANCE_EVENT" "GRANT_AMENDMENT_EVENT" "GRANT_CODE_CLAIMED_EVENT" "GRANT_CREATION_EVENT" "GRANT_HELD_VIA_REGISTER_UPDATE_EVENT" "GRANT_ID_TOKEN_ISSUANCE_EVENT" "GRANT_REACTIVATED_VIA_REGISTER_UPDATE_EVENT" "GRANT_REFRESH_TOKEN_ISSUANCE_EVENT" "GRANT_REVOKED_BY_ADMIN_EVENT" "GRANT_REVOKED_BY_DASHBOARD_EVENT" "GRANT_REVOKED_BY_RECIPIENT_EVENT" "GRANT_REVOKED_VIA_CLOSED_PRINCIPAL_POLL_EVENT" "GRANT_REVOKED_VIA_REGISTER_UPDATE_EVENT" "GRANT_REVOKED_VIA_USER_INELIGIBLE_EVENT" Example: eventType=GRANT_AMENDMENT_EVENT Filter on specific grant event types |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "grantEventUType": "GRANT_AMENDMENT_EVENT",
- "grantLogId": "9824d737-5787-4ab1-97bd-0a81fa2f20c2",
- "created": "2021-01-01T12:30:00Z",
- "content": "Short term access credentials issued till 2022-01-20T17:19:50.586326+10:00 with the following scopes: Direct debits and scheduled payments,Account numbers and features,Account name, type and balance,Transaction details,Contact details,OpenID Profiles,Saved payees,Name and occupation,OpenID Connect"
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}List Grant Accounts
List the Account identifiers that an End User has given during the Grant (Arrangement) establishment process
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "id": "a9a8469b-3364-4bbf-aae2-d0c76f2dea02",
- "accountId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "principalId": "000d7490-a2b7-4f9c-82a3-648fe879905b",
- "accountType": "SINGLE",
- "maskedAccountNumber": "XXXX 1234",
- "accountName": "Everyday Transaction Account",
- "accountCustomers": [
- {
- "principalId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "relationshipType": "OWNER",
- "vulnerable": false
}
], - "notificationPreferences": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}, - "jointAccount": {
- "sharingStatus": "PRE_APPROVAL",
- "sharingStatusLastUpdated": "2022-01-01T12:30:00Z",
- "latestDomsRequest": {
- "requestId": "d1e9dafa-dadd-43a4-a44c-1ba425c65aad",
- "expiry": "2022-01-01T12:30:00Z",
- "targetSharingStatus": "PRE_APPROVAL",
- "status": "PENDING"
}
}
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Withdraw joint account sharing approval
For joint account owner to withdraw sharing approval on the joint account from a specific Grant that was created by another joint account owner.
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 400
- 404
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Invalid",
- "title": "Invalid Field",
- "detail": "Invalid format supplied for fieldName",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Invalid"
}
}
]
}List Grant Consents
While a grant is the top level data structure that has tokens issued against it, consents are the individual temporal histories of that grant as it changes over it's lifespan. As a grant is modified, the current consent is terminated and a new consent is created to reflect the new state.
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "grantConsentId": "f1ddcf6f-1f63-4f3a-a937-12052d776212",
- "created": "2021-01-01T12:30:00Z",
- "superceded": "2021-01-01T15:30:00Z",
- "details": {
- "grantConsentType": "CDR_SHARING_ARRANGEMENT_V1"
}
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Create a new Grant Consent
Creates a new consent and modifies the existing state of the grant to reflect. If the content of this request matches the existing arrangement state then the previous consent response is returned.
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| grantId required | string <uuid> ID of the specific grant |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Request Body schema: application/jsonrequired
| grantConsentType required | string (EnumGrantConsentTypeV1) Default: "CDR_SHARING_ARRANGEMENT_V1" Grant Types
| ||||
| userId required | string The User Identifier who executed the consent | ||||
| scopes required | Array of strings (EnumCDRScopesV1) unique Items Enum: "openid" "profile" "common:customer.basic:read" "common:customer.detail:read" "bank:accounts.basic:read" "bank:accounts.detail:read" "bank:transactions:read" "bank:regular_payments:read" "bank:payees:read" "energy:accounts.basic:read" "energy:accounts.detail:read" "energy:accounts.concessions:read" "energy:accounts.paymentschedule:read" "energy:billing:read" "energy:electricity.servicepoints.basic:read" "energy:electricity.servicepoints.detail:read" "energy:electricity.der:read" "energy:electricity.usage:read" This is a list of scopes related to CDR Sharing Arrangements. | ||||
| accountIds required | Array of strings unique | ||||
| expiry required | string <date-time> The new expiry time of the underlying Grant |
Responses
Request samples
- Payload
{- "grantConsentType": "CDR_SHARING_ARRANGEMENT_V1",
- "userId": "5529e377-b8aa-42c3-8f65-b30aae26e555",
- "scopes": [
- "common:customer.basic:read"
], - "accountIds": [
- "9ecddf78-43f8-408c-aa36-d0f2054ffd98"
], - "expiry": "2021-01-01T12:30:00Z"
}Response samples
- 200
- 400
- 404
{- "grantConsentId": "f1ddcf6f-1f63-4f3a-a937-12052d776212",
- "created": "2021-01-01T12:30:00Z",
- "superceded": "2021-01-01T15:30:00Z",
- "details": {
- "grantConsentType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Get Notification Preferences for an Account
Get Notification Preferences for a specific Account for a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}
}Update Notification Preferences for an Account
Update Notification Preferences for a specific Account for a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Request Body schema: application/jsonrequired
Update the notifications
required | object (UpdateNotificationPreferencesV1) Describes the notification preferences currently specified for the target entity. | ||||||||||
| |||||||||||
Responses
Request samples
- Payload
{- "data": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "userId": "77bdf4ac-f107-4524-aa11-b15086ac1f35"
}
}Response samples
- 200
- 400
- 404
{- "data": {
- "dataSharingStarted": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingStopped": {
- "event": true,
- "weekly": false,
- "monthly": true
}, - "dataSharingNotApproved": true,
- "secondaryUsers": {
- "event": true,
- "weekly": false,
- "monthly": true
}
}
}List Secondary User Instructions for an Account
List Secondary User Instructions for an Account for a specific User
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
| status | string (EnumSecondaryUserSharingStatusV1) Enum: "ENABLED" "DISABLED" Example: status=DISABLED Filter on a specific Secondary User sharing status |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": [
- {
- "secondaryUserUserId": "f23417ff-8de4-4bf7-9f9d-ce0e6ec67cb3",
- "private": false,
- "secondaryUserSharingStatus": "DISABLED"
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Update Secondary User Instruction
Update Secondary User Instruction status
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
| accountId required | string ID of the specific account |
| secondaryUserUserId required | string User ID of the Secondary User |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Request Body schema: application/jsonrequired
Update Secondary User Request
required | object (UpdateSecondaryUserV1) | ||||
| |||||
Responses
Request samples
- Payload
{- "data": {
- "status": "DISABLED",
- "userId": "77bdf4ac-f107-4524-aa11-b15086ac1f35"
}
}Response samples
- 200
- 400
- 404
{- "data": [
- {
- "secondaryUserUserId": "f23417ff-8de4-4bf7-9f9d-ce0e6ec67cb3",
- "private": false,
- "secondaryUserSharingStatus": "DISABLED"
}
], - "meta": {
- "page": 1,
- "pageSize": 25,
- "totalPages": 2,
- "totalRecords": 40,
- "filters": [
- { }
]
}
}Get User
Get User Details for a specific User in the context of a specific Principal
Authorizations:
path Parameters
| principalId required | string ID of the specific Principal requested |
query Parameters
| userId | string ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
Responses
Response samples
- 200
- 400
- 404
{- "data": {
- "vulnerable": false,
- "authorityToOperate": [
- {
- "principalId": "ad383b27-22d5-4da8-beb8-2fcf65029f0d",
- "userId": "4e9cfa0b-5790-41de-8fbe-7e4caec817af",
- "type": "POWER_OF_ATTORNEY"
}
]
}
}Dashboard SSO Request
Requests a signed JWT for use for logging into the biza consumer dashboard with a trusted user and (optionally) principal.
This request object can be given to dashboard to create a link that will log the user into the dashboard. E.g: https://dashboard.biza.io/sso?request=$requestObjectJwt
Only required if using the Biza Consent Dashboard and wanting to login via a prompt free single sign on. Calls to this must be secured by an appropriate authentication mechanism for your digital portal.
Authorizations:
header Parameters
| x-haas-realm-name required | string (DioRealmName) Example: biza-holder Represents the authorisation realm name context for the call being made. |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Request Body schema: application/jsonrequired
required | object (CreateDashboardSsoRequestV1) | ||||
| |||||
Responses
Request samples
- Payload
{- "data": {
- "userId": "8d3bc307-a75a-4899-820b-dcca3cca4fd9",
- "principalId": "14fa42ba-5fbf-498a-95dc-0ab46b560839"
}
}Response samples
- 200
- 400
- 404
{- "jwt": "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJodHRwczpcL1wvaWRwLnNhbmRib3hcL3NhbmRib3gtZGFzaGJvYXJkLWF1dGgiLCJzdWIiOiIwOGMzMWEyYTkwMTZkNmM1MTdhOTU1NjIyMjhhMzdjMDowOGMzMWEyYTkwMTZkNmM1MTdhOTU1NjIyMjhhMzdjMCIsIm5iZiI6MTY2MTEwNDc2MywiaXNzIjoiYml6YS1kYXNoYm9hcmQiLCJleHAiOjE2NjExMDQ5MTMsImlhdCI6MTY2MTEwNDc5M30.vsAgJ1cHKEGBuJ54h8taPC2iK0l1ItBA2XQjaIZGq_3KQfYuU5ctsdnUgu6NRXUWL9bsYLaS5gnbkzw6nbd6zw"
}