Retrieves all security policies
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadstatusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateReturn the SecurityPolicies valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SecurityPolicies are returned. And in the staging environment, PROPOSED SecurityPolicies are preferred to VERSIONED ones. Mutually exclusive with statusFilter.
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves all security policies › Responses
Returns the info
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Create a SecurityPolicy
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Create a SecurityPolicy › Request Body
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Create a SecurityPolicy › Responses
Entity created successfully
Retrieves default security policies
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves default security policies › Responses
Returns the info
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Retrieves the security policy valid on a given date
Requires validOnDate query parameter. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
path Parameters
idThe id to identify a SecurityPolicy
query Parameters
validOnDateReturn the version valid on the given date (ISO-8601).
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves the security policy valid on a given date › Responses
Returns the info
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Retrieves security policy for id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SecurityPolicy
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the SecurityPolicy
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves security policy for id and version › Responses
Returns the info
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Updates an existing SecurityPolicy
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SecurityPolicy
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the SecurityPolicy
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Updates an existing SecurityPolicy › Request Body
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Updates an existing SecurityPolicy › Responses
Entity updated successfully