Skip to main content

Create a new flag

POST 
/references/flags

Creates a new flag configuration

Request​

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.

Body

Request object to create a flag

    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

Responses​

Response with for a single flag

Response Headers

  • x-fapi-interaction-id

    string

Schema

    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

Loading...