Access

Check access

The user needs to be logged in to use this endpoint, 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.

SecurityAuthorization_Code

Request

Request Body schema: application/json

product	string Check if user has access base on product
articleId	string Check if user has access base on specific article id
domain	string Check if user has access base on domain
ip	string Check if user has access base on IP address
categoryType	string Check if user has access based on any subscription with category having this category type
accessAzureAd	boolean 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 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 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 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 Check if user has access base on unique ID (from Profile API).
customerNumber	integer Check if user has access base on a valid and existing customer number in the Connect environment.
credential	string <= 60 characters Check if user has access base on credential e.g. email address or phone number.

Responses

200

Response Schema: application/json

access	boolean The information says if the user has access: true: The user has access. false: The user has no access.
	Array of objects

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/access

Request samples

Payload
curl

application/json

{"product": "CO27409",
"articleId": "578943434",
"domain": "mediaconnect.no",
"ip": "127.0.0.1",
"categoryType": "SWISJ",
"accessAzureAd": true,
"accessAidFamily": true,
"uniqueId": "6ba7b8149dad11d180b400c04fd430c8",
"customerNumber": 563457,
"credential": "+4723339100"
}

Response samples

application/json

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

Check access - 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 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.

SecurityClient_Credentials

Request

Request Body schema: application/json

product	string Check if user has access base on product
articleId	string Check if user has access base on specific article id
domain	string Check if user has access base on domain
ip	string Check if user has access base on IP address
categoryType	string Check if user has access based on any subscription with category having this category type
accessAzureAd	boolean 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 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 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 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 Check if user has access base on unique ID (from Profile API).
customerNumber	integer Check if user has access base on a valid and existing customer number in the Connect environment.
credential	string <= 60 characters Check if user has access base on credential e.g. email address or phone number.

Responses

200

Response Schema: application/json

access	boolean The information says if the user has access: true: The user has access. false: The user has no access.
	Array of objects

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/access

Request samples

Payload
curl

application/json

{"product": "CO27409",
"articleId": "578943434",
"domain": "mediaconnect.no",
"ip": "127.0.0.1",
"categoryType": "SWISJ",
"accessAzureAd": true,
"accessAidFamily": true,
"uniqueId": "6ba7b8149dad11d180b400c04fd430c8",
"customerNumber": 563457,
"credential": "+4723339100"
}

Response samples

application/json

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

➔ Next to Credential