Check access - client mode

Production

https://api.mediaconnect.no/capi

POST

/v1/client/access

Access

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 returns accesses for given user. The access can be given on several levels.

You may have access based on productsubscription, domain, ip address, specific article or categoryType that was bought. You also have access based on use of AzureAd, AidFamily, uniqueId (from Profle API) or customerNumber and credential.

NOTE: If you send a request with two or more fields, then it has to match with them all. If you are checking access based on other than IP, then it is required to send uniqueId or credential together with that field.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/access' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product": "CO27409",
    "articleId": "578943434",
    "domain": "unite.no",
    "ip": "127.0.0.1",
    "categoryType": "SWISJ",
    "accessAzureAd": true,
    "accessAidFamily": true,
    "uniqueId": "6ba7b8149dad11d180b400c04fd430c8",
    "customerNumber": 563457,
    "credential": "+4723339100"
}'

Response Example

200 - Example 1

{
    "access": true,
    "accesses": [
        {
            "access": false,
            "accessLevel": "C",
            "accessType": "D"
        },
        {
            "access": true,
            "accessLevel": "A",
            "accessType": "A"
        }
    ]
}

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

product

string

optional

Check if user has access base on product

articleId

string

optional

Check if user has access base on specific article id

domain

string

optional

Check if user has access base on domain

string

optional

Check if user has access base on IP address

categoryType

string

optional

Check if user has access based on any subscription with category having this category type

accessAzureAd

boolean

optional

Check if user has access to azure active directory :

true: To check if user has access to azure AD

false: Do not check if user has access to azure AD.

accessAidFamily

boolean

optional

Check if user or their aid family has access to given product :

true: To check if user or family has access to given product

false: Do not check if user or family has access to given product.

accessDomain

boolean

optional

Check if user has domain access based on category type :

true: To check if user has domain access based on category type.

false: Do not check if user has domain access based on category type.

accessArticle

boolean

optional

Return a complete article id list that user has access to, unless articleId is also specified :

true: To look up article id list

false: Do not look up article id list.

uniqueId

string

optional

Check if user has access base on unique ID (from Profile API).

customerNumber

integer

optional

Check if user has access base on a valid and existing customer number in the Connect environment.

credential

string

optional

Check if user has access base on credential e.g. email address or phone number.

<= 60 characters

Examples

Responses

🟢200OK

application/json

Body

access

boolean

optional

The information says if the user has access:

true: The user has access.

false: The user has no access.

accesses

array [object {4}]

optional

access

boolean

optional

Access value for specific level of access

accessLevel

enum<string>

optional

Level of access

A: Product, when asking based on product in request

B: Article, when asking based on article id in request, or complete list when asking based on boolean value in request

C: Domain, when asking based on domain in request

D: IP, when asking based on IP address in request

E: Category type, when asking based on category type in request

F: IP & Domain, if sharing depends upon both domain and IP this level is returned in the response

G: Azure active directory, when asking based on boolean value in request

H: aID family, when asking based on boolean value in request.

I: Shared subscription, a subscription is shared with the user.

Allowed values:

ABCDEFGHI

accessType

enum<string>

optional

Type of access:

A: Subscription, when subscription is for product

B: Shared, when subscription on product is shared

C: Article, when user bought specific article(s)

D: Domain, when user has access based on domain

E: IP, when user has access based on IP

F: Require IP login, when user requires login based on IP

G: Category type, when user has access based on category type

Allowed values:

ABCDEFG

accessTypeDetail

object

optional

Details for given access type

🟠400Bad Request

🟠429429

🔴500Server Error

Check access

Check credential - client mode