API docs by Redocly

Integration service API docs (1.3.0)

Download OpenAPI specification:

REST API for BAO Identity service

Users

Get user

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": {
    },
  • "username": "string",
  • "email": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "twoFactorAuth": true,
  • "ssoAuth": true,
  • "ssoId": "string",
  • "auths": [
    ],
  • "fileAccessInstances": [
    ],
  • "userGroups": [
    ],
  • "startPage": "DEFAULT",
  • "status": "INVITATION",
  • "existingAuths": [
    ],
  • "analyticsPlatformEnabled": true,
  • "hasManagerAccess": true,
  • "hasRouteAccess": true,
  • "hasDataPipelineAccess": true,
  • "hasUserAccess": true,
  • "hasClientAccess": true,
  • "displayName": "string"
}

Update user

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
object (Client)
username
required
string
password
string
email
required
string
createdBy
string
lastUpdatedBy
string
twoFactorAuth
boolean
ssoAuth
required
boolean
ssoId
string
auths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
fileAccessInstances
Array of strings unique
Array of objects (UserGroup) unique
startPage
required
string
Enum: "DEFAULT" "MANAGER" "INTEGRATION" "DATA_PIPELINE"
status
string
Enum: "INVITATION" "ACTIVE" "INACTIVE"
existingAuths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
analyticsPlatformEnabled
boolean
hasManagerAccess
boolean
hasRouteAccess
boolean
hasDataPipelineAccess
boolean
hasUserAccess
boolean
hasClientAccess
boolean
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": {
    },
  • "username": "string",
  • "password": "string",
  • "email": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "twoFactorAuth": true,
  • "ssoAuth": true,
  • "ssoId": "string",
  • "auths": [
    ],
  • "fileAccessInstances": [
    ],
  • "userGroups": [
    ],
  • "startPage": "DEFAULT",
  • "status": "INVITATION",
  • "existingAuths": [
    ],
  • "analyticsPlatformEnabled": true,
  • "hasManagerAccess": true,
  • "hasRouteAccess": true,
  • "hasDataPipelineAccess": true,
  • "hasUserAccess": true,
  • "hasClientAccess": true,
  • "displayName": "string"
}

Remove user

path Parameters
uid
required
string

Responses

Update user password

path Parameters
uid
required
string

Responses

Enable two-factor authentication

path Parameters
uid
required
string
code
required
string

Responses

Disable two-factor authentication

path Parameters
uid
required
string
code
required
string

Responses

Reset two-factor authentication

path Parameters
uid
required
string

Responses

Get users

query Parameters
query
string
analyticsPlatform
boolean
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user invitation

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
object (Client)
username
required
string
password
string
email
required
string
createdBy
string
lastUpdatedBy
string
twoFactorAuth
boolean
ssoAuth
required
boolean
ssoId
string
auths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
fileAccessInstances
Array of strings unique
Array of objects (UserGroup) unique
startPage
required
string
Enum: "DEFAULT" "MANAGER" "INTEGRATION" "DATA_PIPELINE"
status
string
Enum: "INVITATION" "ACTIVE" "INACTIVE"
existingAuths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
analyticsPlatformEnabled
boolean
hasManagerAccess
boolean
hasRouteAccess
boolean
hasDataPipelineAccess
boolean
hasUserAccess
boolean
hasClientAccess
boolean
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": {
    },
  • "username": "string",
  • "password": "string",
  • "email": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "twoFactorAuth": true,
  • "ssoAuth": true,
  • "ssoId": "string",
  • "auths": [
    ],
  • "fileAccessInstances": [
    ],
  • "userGroups": [
    ],
  • "startPage": "DEFAULT",
  • "status": "INVITATION",
  • "existingAuths": [
    ],
  • "analyticsPlatformEnabled": true,
  • "hasManagerAccess": true,
  • "hasRouteAccess": true,
  • "hasDataPipelineAccess": true,
  • "hasUserAccess": true,
  • "hasClientAccess": true,
  • "displayName": "string"
}

Reset user

path Parameters
uid
required
string

Responses

Enable user

path Parameters
uid
required
string

Responses

Disable user

path Parameters
uid
required
string

Responses

Create user account

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
object (Client)
username
required
string
password
string
email
required
string
createdBy
string
lastUpdatedBy
string
twoFactorAuth
boolean
ssoAuth
required
boolean
ssoId
string
auths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
fileAccessInstances
Array of strings unique
Array of objects (UserGroup) unique
startPage
required
string
Enum: "DEFAULT" "MANAGER" "INTEGRATION" "DATA_PIPELINE"
status
string
Enum: "INVITATION" "ACTIVE" "INACTIVE"
existingAuths
Array of strings unique
Items Enum: "ROLE_MANAGE_CLIENT" "ROLE_SUPER_ADMIN" "ROLE_MANAGE_USER" "ROLE_MANAGE_USER_GROUP" "ROLE_MANAGE_SSO_PROVIDER_CONFIG" "ROLE_MANAGE_SSO_CLIENT_CONFIG" "ROLE_SEE_INSTANCE" "ROLE_MANAGE_INSTANCE" "ROLE_GET_FILE" "ROLE_GET_FILE_INDIVIDUAL" "ROLE_SEE_AUDIT_LOG" "ROLE_MANAGE_HOSTING_PLAN" "ROLE_SEE_ROUTE" "ROLE_MANAGE_ROUTE" "ROLE_SEE_DATA_PIPELINE" "ROLE_MANAGE_DATA_PIPELINE" "ROLE_SEE_VIEW" "ROLE_MANAGE_VIEW" "ROLE_SEE_SCHEMA" "ROLE_MANAGE_SCHEMA" "ROLE_SEE_DESTINATION" "ROLE_MANAGE_DESTINATION" "ROLE_SEE_WORKFLOW" "ROLE_MANAGE_WORKFLOW" "ROLE_SEE_VARIABLE" "ROLE_MANAGE_VARIABLE" "ROLE_MANAGE_SETTING" "ROLE_SEE_DATA_QUALITY_CHECK" "ROLE_MANAGE_DATA_QUALITY_CHECK" "ROLE_SEE_DATA_QUALITY_CHECK_GROUP" "ROLE_MANAGE_DATA_QUALITY_CHECK_GROUP" "ROLE_SEE_FIREWALL_RULE" "ROLE_MANAGE_FIREWALL_RULE" "ROLE_VIEW_DATA_ANALYTICS_PLATFORM" "ROLE_VIEW_DATA_ALL_DATA_PIPELINE" "ROLE_SEE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_DATA_PIPELINE_CONFIG" "ROLE_MANAGE_PUBLIC_DATASET_CATALOG"
analyticsPlatformEnabled
boolean
hasManagerAccess
boolean
hasRouteAccess
boolean
hasDataPipelineAccess
boolean
hasUserAccess
boolean
hasClientAccess
boolean
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": {
    },
  • "username": "string",
  • "password": "string",
  • "email": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "twoFactorAuth": true,
  • "ssoAuth": true,
  • "ssoId": "string",
  • "auths": [
    ],
  • "fileAccessInstances": [
    ],
  • "userGroups": [
    ],
  • "startPage": "DEFAULT",
  • "status": "INVITATION",
  • "existingAuths": [
    ],
  • "analyticsPlatformEnabled": true,
  • "hasManagerAccess": true,
  • "hasRouteAccess": true,
  • "hasDataPipelineAccess": true,
  • "hasUserAccess": true,
  • "hasClientAccess": true,
  • "displayName": "string"
}

User groups

Get user group

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "client": {
    },
  • "description": "string",
  • "displayName": "string"
}

Update user group

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string
object (Client)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "client": {
    },
  • "description": "string",
  • "displayName": "string"
}

Remove user group

path Parameters
uid
required
string

Responses

Get user groups

query Parameters
query
string
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user group

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string
object (Client)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "client": {
    },
  • "description": "string",
  • "displayName": "string"
}

Add user to group

path Parameters
groupUid
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove user from group

path Parameters
groupUid
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get user group members

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SSO provider configuration

Get SSO provider configuration Deprecated

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "provider": "OKTA",
  • "clientDomain": "string",
  • "mappingClaim": "string"
}

Update SSO provider configuration Deprecated

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
object (Client)
provider
required
string
Enum: "OKTA" "GENERIC"
clientId
string
clientSecret
string
clientDomain
required
string
mappingClaim
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "provider": "OKTA",
  • "clientId": "string",
  • "clientSecret": "string",
  • "clientDomain": "string",
  • "mappingClaim": "string"
}

Remove SSO provider configuation Deprecated

path Parameters
uid
required
string

Responses

Get SSO provider configuration

path Parameters
clientId
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "provider": "OKTA",
  • "clientDomain": "string",
  • "mappingClaim": "string"
}

Update SSO provider configuration

path Parameters
clientId
required
string
uid
required
string
Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
object (Client)
provider
required
string
Enum: "OKTA" "GENERIC"
clientId
string
clientSecret
string
clientDomain
required
string
mappingClaim
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "provider": "OKTA",
  • "clientId": "string",
  • "clientSecret": "string",
  • "clientDomain": "string",
  • "mappingClaim": "string"
}

Remove SSO provider configuation

path Parameters
clientId
required
string
uid
required
string

Responses

Get SSO provider configurations

query Parameters
client
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create SSO provider configuration

Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
object (Client)
provider
required
string
Enum: "OKTA" "GENERIC"
clientId
string
clientSecret
string
clientDomain
required
string
mappingClaim
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "provider": "OKTA",
  • "clientId": "string",
  • "clientSecret": "string",
  • "clientDomain": "string",
  • "mappingClaim": "string"
}

SSO client configuration

Get SSO client configuration

path Parameters
clientId
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "ssoClientId": "string",
  • "clientName": "string",
  • "redirectUris": [
    ],
  • "scopes": [
    ],
  • "grantTypes": [
    ]
}

Update SSO client configuration

path Parameters
clientId
required
string
uid
required
string
Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
object (Client)
ssoClientId
required
string [ 2 .. 2147483647 ] characters
clientSecret
string
clientName
required
string [ 2 .. 2147483647 ] characters
redirectUris
required
Array of strings unique
scopes
required
Array of strings unique
required
Array of objects (AuthorizationGrantType) unique

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "ssoClientId": "string",
  • "clientSecret": "string",
  • "clientName": "string",
  • "redirectUris": [
    ],
  • "scopes": [
    ],
  • "grantTypes": [
    ]
}

Remove SSO client configuation

path Parameters
clientId
required
string
uid
required
string

Responses

Get SSO client configurations

query Parameters
client
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create SSO client configuration

Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
object (Client)
ssoClientId
required
string [ 2 .. 2147483647 ] characters
clientSecret
string
clientName
required
string [ 2 .. 2147483647 ] characters
redirectUris
required
Array of strings unique
scopes
required
Array of strings unique
required
Array of objects (AuthorizationGrantType) unique

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": {
    },
  • "ssoClientId": "string",
  • "clientSecret": "string",
  • "clientName": "string",
  • "redirectUris": [
    ],
  • "scopes": [
    ],
  • "grantTypes": [
    ]
}

Clients

Get client

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Update client

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string [ 2 .. 25 ] characters
billingCode
required
string [ 2 .. 25 ] characters
required
object (ContactInfo)
required
object (ContactInfo)
required
object (ContactInfo)
disabled
required
boolean
domain
required
string
Enum: "REGULAR" "PUBLIC_DATASET_CATALOG" "PEPFAR_DATA_MART"
managerEnabled
required
boolean
routesEnabled
required
boolean
pipelinesEnabled
required
boolean
enterpriseEnabled
required
boolean
routeNotificationEmailAddresses
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Remove client

path Parameters
uid
required
string

Responses

Update restricted active client

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string [ 2 .. 25 ] characters
billingCode
required
string [ 2 .. 25 ] characters
required
object (ContactInfo)
required
object (ContactInfo)
required
object (ContactInfo)
disabled
required
boolean
domain
required
string
Enum: "REGULAR" "PUBLIC_DATASET_CATALOG" "PEPFAR_DATA_MART"
managerEnabled
required
boolean
routesEnabled
required
boolean
pipelinesEnabled
required
boolean
enterpriseEnabled
required
boolean
routeNotificationEmailAddresses
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Get active client

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Update active client

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string [ 2 .. 25 ] characters
billingCode
required
string [ 2 .. 25 ] characters
required
object (ContactInfo)
required
object (ContactInfo)
required
object (ContactInfo)
disabled
required
boolean
domain
required
string
Enum: "REGULAR" "PUBLIC_DATASET_CATALOG" "PEPFAR_DATA_MART"
managerEnabled
required
boolean
routesEnabled
required
boolean
pipelinesEnabled
required
boolean
enterpriseEnabled
required
boolean
routeNotificationEmailAddresses
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Set active client

path Parameters
uid
required
string

Responses

Get clients

query Parameters
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
code
required
string [ 2 .. 25 ] characters
billingCode
required
string [ 2 .. 25 ] characters
required
object (ContactInfo)
required
object (ContactInfo)
required
object (ContactInfo)
disabled
required
boolean
domain
required
string
Enum: "REGULAR" "PUBLIC_DATASET_CATALOG" "PEPFAR_DATA_MART"
managerEnabled
required
boolean
routesEnabled
required
boolean
pipelinesEnabled
required
boolean
enterpriseEnabled
required
boolean
routeNotificationEmailAddresses
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "code": "string",
  • "billingCode": "string",
  • "primaryContact": {
    },
  • "technicalContact": {
    },
  • "billingContact": {
    },
  • "disabled": true,
  • "domain": "REGULAR",
  • "managerEnabled": true,
  • "routesEnabled": true,
  • "pipelinesEnabled": true,
  • "enterpriseEnabled": true,
  • "routeNotificationEmailAddresses": "string",
  • "displayName": "string"
}

Security

Authenticate user

Responses

Get QR code

Responses

User invitations

Realize user invitation

path Parameters
uid
required
string

Responses

Validate user invitation

path Parameters
uid
required
string
code
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": {
    },
  • "username": "string",
  • "email": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "twoFactorAuth": true,
  • "ssoAuth": true,
  • "ssoId": "string",
  • "auths": [
    ],
  • "fileAccessInstances": [
    ],
  • "userGroups": [
    ],
  • "startPage": "DEFAULT",
  • "status": "INVITATION",
  • "existingAuths": [
    ],
  • "analyticsPlatformEnabled": true,
  • "hasManagerAccess": true,
  • "hasRouteAccess": true,
  • "hasDataPipelineAccess": true,
  • "hasUserAccess": true,
  • "hasClientAccess": true,
  • "displayName": "string"
}

Sharing

Search for shareable items

query Parameters
query
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Active user

Get active user

Responses

Response samples

Content type
application/json
{
  • "activeUser": {
    },
  • "user": {
    },
  • "activeClient": {
    },
  • "client": {
    },
  • "config": {
    },
  • "forwardTo": "BAO_MANAGER"
}

Get active user

Responses

Response samples

Content type
application/json
{
  • "activeUser": {
    },
  • "user": {
    },
  • "activeClient": {
    },
  • "client": {
    },
  • "config": {
    },
  • "forwardTo": "BAO_MANAGER"
}

System

Get version info

Responses

Response samples

Content type
application/json
{
  • "group": "string",
  • "artifact": "string",
  • "version": "string",
  • "buildTime": "string"
}

Get system info

query Parameters
systemId
required
string

Responses

Response samples

Content type
application/json
{
  • "systemId": "string",
  • "systemBaseUrl": "string",
  • "emailForwardAddress": "string",
  • "smtpHost": "string"
}

Status

Get status

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Statistics

Get statistics

Responses

Response samples

Content type
application/json
{
  • "clients": 0,
  • "users": 0
}

Reports

Get user report in JSON

query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "table": "string",
  • "metaData": {
    },
  • "title": "string",
  • "rows": [
    ],
  • "subtitle": "string",
  • "visibleRows": [
    ],
  • "metaColumnIndexes": [
    ],
  • "visibleHeaders": [
    ],
  • "height": 0,
  • "width": 0,
  • "visibleWidth": 0,
  • "headers": [
    ]
}

Get user report in HTML

Responses

Get user report in CSV

Responses

Get client report in JSON

Responses

Response samples

Content type
application/json
{
  • "table": "string",
  • "metaData": {
    },
  • "title": "string",
  • "rows": [
    ],
  • "subtitle": "string",
  • "visibleRows": [
    ],
  • "metaColumnIndexes": [
    ],
  • "visibleHeaders": [
    ],
  • "height": 0,
  • "width": 0,
  • "visibleWidth": 0,
  • "headers": [
    ]
}

Get client report in HTML

Responses

Get client report in CSV

Responses