Create a software statement

POST 
/organisations/:OrganisationId/softwarestatements

Creates a software statement. Note that you can add roles as part of this update for a more convenient batch addition

Request

Path Parameters

OrganisationId OrganisationIdrequired

Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

The organisation ID

Header Parameters

x-fapi-auth-date string

Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address string

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id string

An RFC4122 UID used as a correlation id.

x-customer-user-agent string

Indicates the user-agent that the PSU is using.

application/json

Body

required

Software Statement payload

ClientName ClientName (string)required

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Software Statement client name

Description string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Software Statement description

OnBehalfOf string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

A reference to fourth party organisation resource on the RTS Directory if the registering Org is acting on behalf of another

PolicyUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI string that points to a human-readable privacy policy document

ClientUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The Software Statement client compliant URI

LogoUri urirequired

Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

A compliant URI

Environment string

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

The additional check for software statement, this field can avoid environment checks.

Mode SoftwareStatementMode (string)

Possible values: [Live, Test]

Default value: Live

Software Statement mode

RedirectUri uri[]required

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The Software Statement redirect URIs

PostLogoutRedirectUris uri[]

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

ApiWebhookUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^(https:\/\/[^\s/?#]+(?:\/[^\s\/?#]+)*)$

OriginUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^https:\/\/(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]+(?::\d+)?(?:\/[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:\?[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:#[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?$|(^android:apk-key-hash:[a-zA-Z0-9-]+)|(^ios:bundle-id:[a-zA-Z][-a-zA-Z0-9]*\.([a-zA-Z][-a-zA-Z0-9]*\.?)+)$

TermsOfServiceUri urinullable

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI

NotificationWebhook uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI

SoftwareVersion RFCCompliantSoftwareVersion (string)

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

Version SoftwareVersion (number)deprecated

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

AdditionalSoftwareMetadata AdditionalSoftwareMetadata (string)

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Extra metadata defined by the org admins to be loaded into the software statement and made avaiable during introspection

OpenidFederationEnabled OpenidFederationEnabled (boolean)

Is this software statement enabled for federation

OpenidFederationEntityManagementType OpenidFederationEntityManagementType (string)

Possible values: [openid_entity_federation_managed, openid_entity_self_managed]

The type of federation management that applies to this software statement

RequireSignedRequestObject RequireSignedRequestObject (boolean)

Default value: true

Require a signed request object. If this is set to false, the client will not be FAPI compliant

IdTokenSignedResponseAlgorithm IdTokenSignedResponseAlgorithm (string)

Possible values: [PS256, RS256]

Default value: PS256

Signing algorithm that a client expects the server to return an id_token with. Must be PS256

TokenEndpointAuthMethod TokenEndpointAuthMethod (string)

Possible values: non-empty and <= 60 characters, [private_key_jwt, tls_client_auth, client_secret_basic]

Default value: private_key_jwt

Token endpoint authentication method

Roles

object[]

Array [

Status StatusEnum (string)required

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

AuthorisationDomain stringrequired

Possible values: non-empty and <= 30 characters

Authorisation domain for the authority

Role AuthorisationDomainRoleName (string)required

Possible values: non-empty and <= 60 characters, Value must match regular expression ^[^<>]*$

The authorisation domain role name

]

TlsClientCertificateBoundAccessTokens TlsClientCertificateBoundAccessTokens (boolean)

Default value: true

Are the tokens issued for this client bound to a client tls certificate

RelatedAuthorisationServer uuidnullable

ID of the Authorisation Server that is connected to this Software Statement

Flags FlagID (string)[]

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

HomepageUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The URI for the website with details about the application and its services

Responses

201

Get the software statements with the given id

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

OperationWarnings OperationWarning (string)[]

Possible values: [IMAGE_UPLOAD_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_BAD_DATA_ENCODING_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_UNSUPPORTED_IMAGE_FORMAT_PLACEHOLDER_USED, IMAGE_VALIDATION_CONTENT_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_DIMENSIONS_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_MAX_SIZE_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_SVG_VALIDATION_PLACEHOLDER_USED, IMAGE_VALIDATION_CONTENT_WARNING_SUPERUSER_OVERRIDE, IMAGE_VALIDATION_DIMENSIONS_WARNING_SUPERUSER_OVERRIDE]

SoftwareStatementCertifications

object[]

Array [

CertificationStartDate CertificationStartDate (string)

Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

JSONDatetime of certification start date

CertificationExpirationDate CertificationExpirationDate (string)

Possible values: Value must match regular expression ^[^<>]*$

JSONDatetime of certification expiration date

CertificationId SoftwareStatementCertificationId (string)

Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

Unique ID associated with the software statement certification

SoftwareStatementId SoftwareStatementId (string)

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

Unique Software Statement Id

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

ProfileVariant ProfileVariant (string)

Possible values: Value must match regular expression ^[^<>]*$

Certification variant

ProfileType ProfileType (string)

Possible values: Value must match regular expression ^[^<>]*$

Certification type

ProfileVersion number

The version number of the certification

CertificationURI uri

Possible values: <= 500 characters, Value must match regular expression ^(https://).*

Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

CertificationStatus CertificationStatusEnum (string)

Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

Default value: Awaiting Certification

The different types of certification status

]

Status string

Possible values: [Active, Suspended, Inactive]

Default value: Active

Is this software statement Active/Suspended/Inactive

ClientId ClientId (string)

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Software Statement client Id

ClientName ClientName (string)

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Software Statement client name

Description string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Software Statement description

Environment string

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

The additional check for software statement, this field can avoid

FederationEndpoint uri

Possible values: <= 255 characters, Value must match regular expression ^(https://).*

The federation endpoint for the Authorisation Server

OrganisationId OrganisationId (string)

Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

Unique ID associated with the organisation

SoftwareStatementId SoftwareStatementId (string)

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

Unique Software Statement Id

Mode SoftwareStatementMode (string)

Possible values: [Live, Test]

Default value: Live

Software Statement mode

RtsClientCreated boolean

Client created flag

OnBehalfOf string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

A reference to fourth party organisation resource on the RTS Directory if the registering Org is acting on behalf of another

PolicyUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI string that points to a human-readable privacy policy document

ClientUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The Software Statement client compliant URI

LogoUri uri

Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

A compliant URI

RedirectUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

PostLogoutRedirectUris uri[]

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

ApiWebhookUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^(https:\/\/[^\s/?#]+(?:\/[^\s\/?#]+)*)$

TermsOfServiceUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The Software Statement terms of service compliant URI

NotificationWebhook uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI

NotificationWebhookStatus NotificationWebhookStatusEnum (string)

Possible values: [Pending, Confirmed, Deactivated]

Default value: Pending

SoftwareVersion RFCCompliantSoftwareVersion (string)

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

Version SoftwareVersion (number)deprecated

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

Locked boolean

Flag shows if assertion has been generated on the software statement - will be set to true when assertion is generated

UpdateFailed boolean

Flag shows if software statement is in failed update state

UpdateFailedReason string

Possible values: Value must match regular expression ^[^<>]*$

Error message describing why the update failed

AdditionalSoftwareMetadata AdditionalSoftwareMetadata (string)

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Extra metadata defined by the org admins to be loaded into the software statement and made avaiable during introspection

OpenidFederationEnabled OpenidFederationEnabled (boolean)

Is this software statement enabled for federation

OpenidFederationEntityManagementType OpenidFederationEntityManagementType (string)

Possible values: [openid_entity_federation_managed, openid_entity_self_managed]

The type of federation management that applies to this software statement

RequireSignedRequestObject RequireSignedRequestObject (boolean)

Default value: true

Require a signed request object. If this is set to false, the client will not be FAPI compliant

IdTokenSignedResponseAlgorithm IdTokenSignedResponseAlgorithm (string)

Possible values: [PS256, RS256]

Default value: PS256

Signing algorithm that a client expects the server to return an id_token with. Must be PS256

TokenEndpointAuthMethod TokenEndpointAuthMethod (string)

Possible values: non-empty and <= 60 characters, [private_key_jwt, tls_client_auth, client_secret_basic]

Default value: private_key_jwt

Token endpoint authentication method

ClientSecret string

Possible values: <= 255 characters

The client secret, only returned when a client is created/updated to have client_secret_basic auth type

CreatedAt date-time
OriginUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^https:\/\/(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]+(?::\d+)?(?:\/[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:\?[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:#[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?$|(^android:apk-key-hash:[a-zA-Z0-9-]+)|(^ios:bundle-id:[a-zA-Z][-a-zA-Z0-9]*\.([a-zA-Z][-a-zA-Z0-9]*\.?)+)$

TlsClientCertificateBoundAccessTokens TlsClientCertificateBoundAccessTokens (boolean)

Default value: true

Are the tokens issued for this client bound to a client tls certificate

RelatedAuthorisationServer uuidnullable

ID of the Authorisation Server that is connected to this Software Statement

Flags

object[]

Array [

Id FlagID (string)

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

Unique ID of the flag

CreatedAt date-time

UpdatedAt date-time

Name FlagName (string)required

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

The name of this flag

Description FlagDescription (string)

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

The description of this flag

Type FlagType (string)required

Possible values: [Organisation, Software_Statement, Authorisation_Server]

The type of this tag

Value FlagValue (string)required

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

The value of this flag

Status StatusEnum (string)required

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

AccessLevel FlagAccessLevel (integer)required

The access level of a flag as a number. The higher the number, the more sensitive it is

]

HomepageUri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The URI for the website with details about the application and its services

Example (from schema)

{
  "OperationWarnings": [
    "IMAGE_UPLOAD_FAILURE_PLACEHOLDER_USED"
  ],
  "SoftwareStatementCertifications": [
    {
      "CertificationStartDate": "string",
      "CertificationExpirationDate": "string",
      "CertificationId": "string",
      "SoftwareStatementId": "string",
      "Status": "Active",
      "ProfileVariant": "FAPI Adv. OP w/ MTLS",
      "ProfileType": "Redirect",
      "ProfileVersion": 0,
      "CertificationURI": "string",
      "CertificationStatus": "Awaiting Certification"
    }
  ],
  "Status": "Active",
  "ClientId": "string",
  "ClientName": "string",
  "Description": "string",
  "Environment": "string",
  "FederationEndpoint": "string",
  "OrganisationId": "string",
  "SoftwareStatementId": "string",
  "Mode": "Live",
  "RtsClientCreated": true,
  "OnBehalfOf": "string",
  "PolicyUri": "string",
  "ClientUri": "string",
  "LogoUri": "string",
  "RedirectUri": [
    "string"
  ],
  "PostLogoutRedirectUris": [
    "string"
  ],
  "ApiWebhookUri": [
    "string"
  ],
  "TermsOfServiceUri": "string",
  "NotificationWebhook": "string",
  "NotificationWebhookStatus": "Pending",
  "SoftwareVersion": "string",
  "Locked": true,
  "UpdateFailed": true,
  "UpdateFailedReason": "string",
  "AdditionalSoftwareMetadata": "string",
  "OpenidFederationEnabled": false,
  "OpenidFederationEntityManagementType": "openid_entity_federation_managed",
  "RequireSignedRequestObject": true,
  "IdTokenSignedResponseAlgorithm": "PS256",
  "TokenEndpointAuthMethod": "private_key_jwt",
  "ClientSecret": "string",
  "CreatedAt": "2024-07-29T15:51:28.071Z",
  "OriginUri": [
    "string"
  ],
  "TlsClientCertificateBoundAccessTokens": true,
  "RelatedAuthorisationServer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Flags": [
    {
      "Id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "CreatedAt": "2024-07-29T15:51:28.071Z",
      "UpdatedAt": "2024-07-29T15:51:28.071Z",
      "Name": "string",
      "Description": "string",
      "Type": "Organisation",
      "Value": "string",
      "Status": "Active",
      "AccessLevel": 0
    }
  ],
  "HomepageUri": "string"
}

400

Bad Request

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

429

Too many requests, maximum capacity reached. Requests are now throttled.

Response Headers

• x-fapi-interaction-id

  string

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

Response Headers

• x-fapi-interaction-id

  string

Loading...