Endpoint Authorisations

Describe how the authorisation for using an endpoint should be obtained.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32

The AuthorisationEndpointMethodId field in the EndpointAuthorisation table is an integer field used to store the unique identifier for the method of authorisation used when an access request is made to an endpoint.

string
required
length between 1 and 450

The GrantTypeId field in the EndpointAuthorisation table is a character field of type nvarchar with a maximum length of 450. This column holds a unique identifier, typically representing one or more endpoint authorisation grants such as SAML, OAuth2, or other authentication protocols.

int32

The EndpointId field of data type int in the EndpointAuthorisation table stores the unique identifier of an endpoint that has been authorised for use within the system. It is used to link authorisation information to its corresponding endpoint.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!