Register external Id - client mode

Production

https://api.mediaconnect.no/capi

POST

/v1/client/extid

External Identity

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/extid' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "59cb6372-d3db-11e5-ab30-625662870761",
    "credentialType": "D"
}'

Response Example

200 - Success

{
    "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"
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

externalId

string

required

External system unique id that represents user in third part system.

<= 60 characters

credentialType

enum<string>

required

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)

Allowed values:

DEHILMXZ

Examples

Responses

🟢200OK

application/json

Body

credential

string

optional

Representation of user that uses the ConnectID service

<= 60 characters

externalId

string

optional

External system unique id that represents user in third part system

<= 60 characters

credentialType

string

optional

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

optional

Says if user can login, eg. call other logged in user API:

true: User can login.

false: User can not login.

customerNumber

integer

optional

Customer number in Connect system if is set.

uniqueId

string

optional

External id to user in ConnectID, additional info

<= 32 characters

enabled

boolean

optional

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

optional

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

optional

Generated jwt token to be used with custom grant_type described here to obtain an access_token

🟠400Bad Request

🟠429429

🔴500Server Error

List external user profiles