External Identity

The external identity API enables third party identity management systems to work with ConnectID API. With the use of this API it will be possible to connect an external id provider system with ConnectID and Connect Customer to call all APIs as if ConnectID was used as the id provider. The API allows the client to create match between external system id and user/credential in ConnectID. It will be possible to match Connect customer number with user in external system.

Register external Id - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API is to ensure that the external Id is registered in ConnectID. The API will do a look up for the existence of the externalId in ConnectID. In addition, a check will be performed to see if the external id is connected to a customer in Connect. First time this API is called for an external id, a user handle will be created in ConnectID and the data stored on the external id will be returned. customerNumber is only returned if was set previously on this externalId. The API returns basic information associated for the external id.

SecurityClient_Credentials

Request

Request Body schema: application/json

externalId required	string <= 60 characters External system unique id that represents user in third part system.
credentialType required	string Credential type, for now it is only allowed type D: AID E: Egmont ID H: Byggforetagen OpenID I: Coruscant ID L: LRF Media ID M: Mentor ID X: External Z: Zephr (Hegnar) Enum: "D" "E" "H" "I" "L" "M" "X" "Z"

Responses

200

Response Schema: application/json

credential	string <= 60 characters Representation of user that uses the ConnectID service
externalId	string <= 60 characters External system unique id that represents user in third part system
credentialType	string Credential type, for now it is only returned type: D: aID E: Egmont ID H: Byggforetagen OpenID I: Coruscant ID L: LRF Media ID M: Mentor ID X: External Z: Zephr (Hegnar)
canLogin	boolean Says if user can login, eg. call other logged in user API: true: User can login. false: User can not login.
customerNumber	integer Customer number in Connect system if is set.
uniqueId	string <= 32 characters External id to user in ConnectID, additional info
enabled	boolean Says if user is enabled in ConnectID and can be used by other systems. true: User is enabled in ConnectID and can be used by other systems. false: User is not enabled in ConnectedID and can not be used by other systems.
newUser	boolean Says if user is created just now or exist from before. true: The user is created just now. false: The user exist from before.
extidCode	string Generated jwt token to be used with custom grant_type described here to obtain an access_token

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/extid

Request samples

Payload
curl

application/json

{"externalId": "59cb6372-d3db-11e5-ab30-625662870761",
"credentialType": "D"
}

Response samples

application/json

{"credential": "AID:59cb6372-d3db-11e5-ab30-625662870761",
"externalId": "59cb6372-d3db-11e5-ab30-625662870761",
"credentialType": "D",
"canLogin": true,
"customerNumber": 327492,
"uniqueId": "681b86aac2cf44ecb13eeb48cb3a7b7d",
"enabled": true,
"newUser": false,
"extidCode": "eyJhbGciOiJIUzUxMiJ9.....eyJjdCI6IkRfQ"
}

Register customer - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API is used to associate a Connect customer with an external id previously registered in ConnectID. Based on this data, the user handle will be created or returned if it already exists. This API returns the same response data as the register external id API. It can be sent as the next API call after register external id API, to associate externalId with customerNumber in Connect.

SecurityClient_Credentials

Request

Request Body schema: application/json

externalId required	string <= 60 characters External system unique id that represents user in third part system
credentialType required	string Credential type, for now it is only allowed type: D: AID
customerNumber	integer Customer number for this user

Responses

200

Response Schema: application/json

credential	string <= 60 characters Representation of user that uses the ConnectID service
externalId	string <= 60 characters External system unique id that represents user in third part system
credentialType	string Credential type, for now it is only returned type: D: aID E: Egmont ID H: Byggforetagen OpenID I: Coruscant ID L: LRF Media ID M: Mentor ID X: External Z: Zephr (Hegnar)
canLogin	boolean Says if user can login, eg. call other logged in user API: true: User can login. false: User can not login.
customerNumber	integer Customer number in Connect system if is set.
uniqueId	string <= 32 characters External id to user in ConnectID, additional info
enabled	boolean Says if user is enabled in ConnectID and can be used by other systems. true: User is enabled in ConnectID and can be used by other systems. false: User is not enabled in ConnectedID and can not be used by other systems.
newUser	boolean Says if user is created just now or exist from before. true: The user is created just now. false: The user exist from before.
extidCode	string Generated jwt token to be used with custom grant_type described here to obtain an access_token

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/extid/customer

Request samples

Payload
curl

application/json

{"externalId": "59cb6372-d3db-11e5-ab30-625662870761",
"credentialType": "D",
"customerNumber": 327492
}

Response samples

application/json

{"credential": "AID:59cb6372-d3db-11e5-ab30-625662870761",
"externalId": "59cb6372-d3db-11e5-ab30-625662870761",
"credentialType": "D",
"canLogin": false,
"uniqueId": "681b86aac2cf44ecb13eeb48cb3a7b7d",
"enabled": false,
"newUser": true,
"extidCode": "eyJhbGciOiJIUzUxMiJ9.....eyJjdCI6IkRfQ"
}

➔ Next to Message