CBL

Outgoing Messages

CBLStateChanged

(Deprecated) Notifies the platform implementation of an authorization flow state change.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "CBLStateChanged"
        }
    },
    "payload": {
        "state": {{CBLState}},
        "reason": {{CBLStateChangedReason}},
        "url": {{String}},
        "code": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
state	CBLState	Yes	State of the CBL Authorization flow.
reason	CBLStateChangedReason	Yes	The state change reason.
url	String	Yes	The localeized url to enter the CBL code.
code	String	Yes	The CBL code.

ClearRefreshToken

(Deprecated) Notifies the platform implementation to clear the refresh token.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "ClearRefreshToken"
        }
    }
}

SetRefreshToken

(Deprecated) Notifies the platform implemnentation to set the refresh token.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "SetRefreshToken"
        }
    },
    "payload": {
        "refreshToken": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
refreshToken	String	Yes	The refresh token.

GetRefreshToken

(Deprecated) Returns the refresh token stored by the platform implementation, otherwise return an empty string.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "GetRefreshToken"
        }
    }
}

SetUserProfile

(Deprecated) Notifies the platform implementation about the user profile. This is notified only when requestUserProfile is enabled in the configuration.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "SetUserProfile"
        }
    },
    "payload": {
        "name": {{String}},
        "email": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
name	String	Yes	The logged in user name.
email	String	Yes	The logged in user email.

Incoming Messages

Start

(Deprecated) Notifies the Engine to cancel the authorization process.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "Start"
        }
    }
}

Cancel

(Deprecated) Notifies the Engine to cancel the authorization process.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "Cancel"
        }
    }
}

Reset

(Deprecated) Notifies the Engine to reset the authorization state.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "Reset"
        }
    }
}

GetRefreshTokenReply

Reply for GetRefreshToken message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "CBL",
            "action": "GetRefreshToken",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "refreshToken": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
refreshToken	String	Yes	The refresh token.

Enums

CBLState

Specifies the state of the authorization flow.

Values

Value	Description
"STARTING"	CBL process is starting.
"REQUESTING_CODE_PAIR"	Initiating the process to request a code pair.
"CODE_PAIR_RECEIVED"	Code pair is received and is waiting on user to authenticate.
"REFRESHING_TOKEN"	Refreshing token stage has begun.
"REQUESTING_TOKEN"	Requesting for authorization token.
"STOPPING"	CBL process is ending.

CBLStateChangedReason

Specifies the reason for the state change.

Values

Value	Description
"SUCCESS"	The CBL state changed successfully.
"ERROR"	Error occurred in the CBL process.
"TIMEOUT"	Request timed out.
"CODE_PAIR_EXPIRED"	Code pair has expired and user will need to initiate the authentication process again.
"AUTHORIZATION_EXPIRED"	The refresh token is invalid, revoked, or was issued to a different client.
"NONE"	No reason specified.