Jump to

• Request
• Response

User Service

put

ss/oc-cnpolicy-configuration/v1/services/pcfuser

Request

Supported Media Types

• application/json

Body ()

body

Root Schema : UserService

Type: object

Title: UserService

Show Source

• chf(optional): object CHFConfiguration
  Title: CHFConfiguration
• common(optional): object CommonConfiguration
  Title: CommonConfiguration
• db(optional): object DBConfiguration
  Title: DBConfiguration
• system(optional): object UserSystemConfiguration
  Title: UserSystemConfiguration
• udr(optional): object UDRConfiguration
  Title: UDRConfiguration

{
    "type":"object",
    "properties":{
        "chf":{
            "$ref":"#/definitions/CHFConfiguration"
        },
        "common":{
            "$ref":"#/definitions/CommonConfiguration"
        },
        "db":{
            "$ref":"#/definitions/DBConfiguration"
        },
        "system":{
            "$ref":"#/definitions/UserSystemConfiguration"
        },
        "udr":{
            "$ref":"#/definitions/UDRConfiguration"
        }
    },
    "title":"UserService"
}

Nested Schema : CHFConfiguration

Type: object

Title: CHFConfiguration

Show Source

• retryProfile(optional): string

{
    "type":"object",
    "properties":{
        "retryProfile":{
            "type":"string"
        }
    },
    "title":"CHFConfiguration"
}

Nested Schema : CommonConfiguration

Type: object

Title: CommonConfiguration

Show Source

• requestTimeout(optional): string
  Example: 1000
• resourceGetSub(optional): boolean

{
    "type":"object",
    "properties":{
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "resourceGetSub":{
            "type":"boolean"
        }
    },
    "title":"CommonConfiguration"
}

Nested Schema : DBConfiguration

Type: object

Title: DBConfiguration

Show Source

• indexing(optional): object Indexing
  Title: Indexing
• keysPrecedence(optional): array keysPrecedence
• userIndexKeys(optional): array userIndexKeys

{
    "type":"object",
    "properties":{
        "indexing":{
            "$ref":"#/definitions/Indexing"
        },
        "keysPrecedence":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "EXTID",
                    "IMSI",
                    "MSISDN",
                    "NAI"
                ]
            }
        },
        "userIndexKeys":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "extid",
                    "imsi",
                    "msisdn",
                    "nai"
                ]
            }
        }
    },
    "title":"DBConfiguration"
}

Nested Schema : UserSystemConfiguration

Type: object

Title: UserSystemConfiguration

Show Source

• apiRoot(optional): string
• loglevel(optional): string
  Allowed Values: [ "DEBUG", "ERROR", "INFO", "WARN" ]

{
    "type":"object",
    "properties":{
        "apiRoot":{
            "type":"string"
        },
        "loglevel":{
            "type":"string",
            "enum":[
                "DEBUG",
                "ERROR",
                "INFO",
                "WARN"
            ]
        }
    },
    "title":"UserSystemConfiguration"
}

Nested Schema : UDRConfiguration

Type: object

Title: UDRConfiguration

Show Source

• amDataUri(optional): string
  Example: /policy-data/ues/{ueId}/am-data
• baseUri(optional): string
  Example: /nudr-dr/v1
• discoverUdrWithPolicyAsSupportedDataSet(optional): boolean
• enableDiscoveryOnDemand(optional): boolean
• enableHttp11(optional): boolean
• explodeSnssai(optional): boolean
• requestTimeout(optional): string
  Example: 1000
• retryProfile(optional): string
• smDataSubscriptionResource(optional): string
  Allowed Values: [ "1", "2" ]
• smDataUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data
• subsToNotifySubsIdUri(optional): string
  Example: /policy-data/subs-to-notify/{subsId}
• subsToNotifyUri(optional): string
  Example: /policy-data/subs-to-notify
• supportedFeatures(optional): string
  Example: f
• uePolicySetUri(optional): string
  Example: /policy-data/ues/{ueId}/ue-policy-set
• usageMonUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data/{usageMonId}

{
    "type":"object",
    "properties":{
        "amDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/am-data"
        },
        "baseUri":{
            "type":"string",
            "example":"/nudr-dr/v1"
        },
        "discoverUdrWithPolicyAsSupportedDataSet":{
            "type":"boolean"
        },
        "enableDiscoveryOnDemand":{
            "type":"boolean"
        },
        "enableHttp11":{
            "type":"boolean"
        },
        "explodeSnssai":{
            "type":"boolean"
        },
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "retryProfile":{
            "type":"string"
        },
        "smDataSubscriptionResource":{
            "type":"string",
            "enum":[
                "1",
                "2"
            ]
        },
        "smDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data"
        },
        "subsToNotifySubsIdUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify/{subsId}"
        },
        "subsToNotifyUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify"
        },
        "supportedFeatures":{
            "type":"string",
            "example":"f"
        },
        "uePolicySetUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/ue-policy-set"
        },
        "usageMonUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data/{usageMonId}"
        }
    },
    "title":"UDRConfiguration"
}

Nested Schema : Indexing

Type: object

Title: Indexing

Show Source

• indexByExtid(optional): boolean
• indexByImsi(optional): boolean
• indexByMsisdn(optional): boolean
• indexByNai(optional): boolean

{
    "type":"object",
    "properties":{
        "indexByExtid":{
            "type":"boolean"
        },
        "indexByImsi":{
            "type":"boolean"
        },
        "indexByMsisdn":{
            "type":"boolean"
        },
        "indexByNai":{
            "type":"boolean"
        }
    },
    "title":"Indexing"
}

Nested Schema : keysPrecedence

Type: array

Show Source

• Array of: string
  Allowed Values: [ "EXTID", "IMSI", "MSISDN", "NAI" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "EXTID",
            "IMSI",
            "MSISDN",
            "NAI"
        ]
    }
}

Nested Schema : userIndexKeys

Type: array

Show Source

• Array of: string
  Allowed Values: [ "extid", "imsi", "msisdn", "nai" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "extid",
            "imsi",
            "msisdn",
            "nai"
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Updated.

Body ()

Root Schema : UserService

Type: object

Title: UserService

Show Source

• chf(optional): object CHFConfiguration
  Title: CHFConfiguration
• common(optional): object CommonConfiguration
  Title: CommonConfiguration
• db(optional): object DBConfiguration
  Title: DBConfiguration
• system(optional): object UserSystemConfiguration
  Title: UserSystemConfiguration
• udr(optional): object UDRConfiguration
  Title: UDRConfiguration

{
    "type":"object",
    "properties":{
        "chf":{
            "$ref":"#/definitions/CHFConfiguration"
        },
        "common":{
            "$ref":"#/definitions/CommonConfiguration"
        },
        "db":{
            "$ref":"#/definitions/DBConfiguration"
        },
        "system":{
            "$ref":"#/definitions/UserSystemConfiguration"
        },
        "udr":{
            "$ref":"#/definitions/UDRConfiguration"
        }
    },
    "title":"UserService"
}

Nested Schema : CHFConfiguration

Type: object

Title: CHFConfiguration

Show Source

• retryProfile(optional): string

{
    "type":"object",
    "properties":{
        "retryProfile":{
            "type":"string"
        }
    },
    "title":"CHFConfiguration"
}

Nested Schema : CommonConfiguration

Type: object

Title: CommonConfiguration

Show Source

• requestTimeout(optional): string
  Example: 1000
• resourceGetSub(optional): boolean

{
    "type":"object",
    "properties":{
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "resourceGetSub":{
            "type":"boolean"
        }
    },
    "title":"CommonConfiguration"
}

Nested Schema : DBConfiguration

Type: object

Title: DBConfiguration

Show Source

• indexing(optional): object Indexing
  Title: Indexing
• keysPrecedence(optional): array keysPrecedence
• userIndexKeys(optional): array userIndexKeys

{
    "type":"object",
    "properties":{
        "indexing":{
            "$ref":"#/definitions/Indexing"
        },
        "keysPrecedence":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "EXTID",
                    "IMSI",
                    "MSISDN",
                    "NAI"
                ]
            }
        },
        "userIndexKeys":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "extid",
                    "imsi",
                    "msisdn",
                    "nai"
                ]
            }
        }
    },
    "title":"DBConfiguration"
}

Nested Schema : UserSystemConfiguration

Type: object

Title: UserSystemConfiguration

Show Source

• apiRoot(optional): string
• loglevel(optional): string
  Allowed Values: [ "DEBUG", "ERROR", "INFO", "WARN" ]

{
    "type":"object",
    "properties":{
        "apiRoot":{
            "type":"string"
        },
        "loglevel":{
            "type":"string",
            "enum":[
                "DEBUG",
                "ERROR",
                "INFO",
                "WARN"
            ]
        }
    },
    "title":"UserSystemConfiguration"
}

Nested Schema : UDRConfiguration

Type: object

Title: UDRConfiguration

Show Source

• amDataUri(optional): string
  Example: /policy-data/ues/{ueId}/am-data
• baseUri(optional): string
  Example: /nudr-dr/v1
• discoverUdrWithPolicyAsSupportedDataSet(optional): boolean
• enableDiscoveryOnDemand(optional): boolean
• enableHttp11(optional): boolean
• explodeSnssai(optional): boolean
• requestTimeout(optional): string
  Example: 1000
• retryProfile(optional): string
• smDataSubscriptionResource(optional): string
  Allowed Values: [ "1", "2" ]
• smDataUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data
• subsToNotifySubsIdUri(optional): string
  Example: /policy-data/subs-to-notify/{subsId}
• subsToNotifyUri(optional): string
  Example: /policy-data/subs-to-notify
• supportedFeatures(optional): string
  Example: f
• uePolicySetUri(optional): string
  Example: /policy-data/ues/{ueId}/ue-policy-set
• usageMonUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data/{usageMonId}

{
    "type":"object",
    "properties":{
        "amDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/am-data"
        },
        "baseUri":{
            "type":"string",
            "example":"/nudr-dr/v1"
        },
        "discoverUdrWithPolicyAsSupportedDataSet":{
            "type":"boolean"
        },
        "enableDiscoveryOnDemand":{
            "type":"boolean"
        },
        "enableHttp11":{
            "type":"boolean"
        },
        "explodeSnssai":{
            "type":"boolean"
        },
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "retryProfile":{
            "type":"string"
        },
        "smDataSubscriptionResource":{
            "type":"string",
            "enum":[
                "1",
                "2"
            ]
        },
        "smDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data"
        },
        "subsToNotifySubsIdUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify/{subsId}"
        },
        "subsToNotifyUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify"
        },
        "supportedFeatures":{
            "type":"string",
            "example":"f"
        },
        "uePolicySetUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/ue-policy-set"
        },
        "usageMonUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data/{usageMonId}"
        }
    },
    "title":"UDRConfiguration"
}

Nested Schema : Indexing

Type: object

Title: Indexing

Show Source

• indexByExtid(optional): boolean
• indexByImsi(optional): boolean
• indexByMsisdn(optional): boolean
• indexByNai(optional): boolean

{
    "type":"object",
    "properties":{
        "indexByExtid":{
            "type":"boolean"
        },
        "indexByImsi":{
            "type":"boolean"
        },
        "indexByMsisdn":{
            "type":"boolean"
        },
        "indexByNai":{
            "type":"boolean"
        }
    },
    "title":"Indexing"
}

Nested Schema : keysPrecedence

Type: array

Show Source

• Array of: string
  Allowed Values: [ "EXTID", "IMSI", "MSISDN", "NAI" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "EXTID",
            "IMSI",
            "MSISDN",
            "NAI"
        ]
    }
}

Nested Schema : userIndexKeys

Type: array

Show Source

• Array of: string
  Allowed Values: [ "extid", "imsi", "msisdn", "nai" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "extid",
            "imsi",
            "msisdn",
            "nai"
        ]
    }
}

201 Response

Created

Body ()

Root Schema : UserService

Type: object

Title: UserService

Show Source

• chf(optional): object CHFConfiguration
  Title: CHFConfiguration
• common(optional): object CommonConfiguration
  Title: CommonConfiguration
• db(optional): object DBConfiguration
  Title: DBConfiguration
• system(optional): object UserSystemConfiguration
  Title: UserSystemConfiguration
• udr(optional): object UDRConfiguration
  Title: UDRConfiguration

{
    "type":"object",
    "properties":{
        "chf":{
            "$ref":"#/definitions/CHFConfiguration"
        },
        "common":{
            "$ref":"#/definitions/CommonConfiguration"
        },
        "db":{
            "$ref":"#/definitions/DBConfiguration"
        },
        "system":{
            "$ref":"#/definitions/UserSystemConfiguration"
        },
        "udr":{
            "$ref":"#/definitions/UDRConfiguration"
        }
    },
    "title":"UserService"
}

Nested Schema : CHFConfiguration

Type: object

Title: CHFConfiguration

Show Source

• retryProfile(optional): string

{
    "type":"object",
    "properties":{
        "retryProfile":{
            "type":"string"
        }
    },
    "title":"CHFConfiguration"
}

Nested Schema : CommonConfiguration

Type: object

Title: CommonConfiguration

Show Source

• requestTimeout(optional): string
  Example: 1000
• resourceGetSub(optional): boolean

{
    "type":"object",
    "properties":{
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "resourceGetSub":{
            "type":"boolean"
        }
    },
    "title":"CommonConfiguration"
}

Nested Schema : DBConfiguration

Type: object

Title: DBConfiguration

Show Source

• indexing(optional): object Indexing
  Title: Indexing
• keysPrecedence(optional): array keysPrecedence
• userIndexKeys(optional): array userIndexKeys

{
    "type":"object",
    "properties":{
        "indexing":{
            "$ref":"#/definitions/Indexing"
        },
        "keysPrecedence":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "EXTID",
                    "IMSI",
                    "MSISDN",
                    "NAI"
                ]
            }
        },
        "userIndexKeys":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "extid",
                    "imsi",
                    "msisdn",
                    "nai"
                ]
            }
        }
    },
    "title":"DBConfiguration"
}

Nested Schema : UserSystemConfiguration

Type: object

Title: UserSystemConfiguration

Show Source

• apiRoot(optional): string
• loglevel(optional): string
  Allowed Values: [ "DEBUG", "ERROR", "INFO", "WARN" ]

{
    "type":"object",
    "properties":{
        "apiRoot":{
            "type":"string"
        },
        "loglevel":{
            "type":"string",
            "enum":[
                "DEBUG",
                "ERROR",
                "INFO",
                "WARN"
            ]
        }
    },
    "title":"UserSystemConfiguration"
}

Nested Schema : UDRConfiguration

Type: object

Title: UDRConfiguration

Show Source

• amDataUri(optional): string
  Example: /policy-data/ues/{ueId}/am-data
• baseUri(optional): string
  Example: /nudr-dr/v1
• discoverUdrWithPolicyAsSupportedDataSet(optional): boolean
• enableDiscoveryOnDemand(optional): boolean
• enableHttp11(optional): boolean
• explodeSnssai(optional): boolean
• requestTimeout(optional): string
  Example: 1000
• retryProfile(optional): string
• smDataSubscriptionResource(optional): string
  Allowed Values: [ "1", "2" ]
• smDataUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data
• subsToNotifySubsIdUri(optional): string
  Example: /policy-data/subs-to-notify/{subsId}
• subsToNotifyUri(optional): string
  Example: /policy-data/subs-to-notify
• supportedFeatures(optional): string
  Example: f
• uePolicySetUri(optional): string
  Example: /policy-data/ues/{ueId}/ue-policy-set
• usageMonUri(optional): string
  Example: /policy-data/ues/{ueId}/sm-data/{usageMonId}

{
    "type":"object",
    "properties":{
        "amDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/am-data"
        },
        "baseUri":{
            "type":"string",
            "example":"/nudr-dr/v1"
        },
        "discoverUdrWithPolicyAsSupportedDataSet":{
            "type":"boolean"
        },
        "enableDiscoveryOnDemand":{
            "type":"boolean"
        },
        "enableHttp11":{
            "type":"boolean"
        },
        "explodeSnssai":{
            "type":"boolean"
        },
        "requestTimeout":{
            "type":"string",
            "example":1000
        },
        "retryProfile":{
            "type":"string"
        },
        "smDataSubscriptionResource":{
            "type":"string",
            "enum":[
                "1",
                "2"
            ]
        },
        "smDataUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data"
        },
        "subsToNotifySubsIdUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify/{subsId}"
        },
        "subsToNotifyUri":{
            "type":"string",
            "example":"/policy-data/subs-to-notify"
        },
        "supportedFeatures":{
            "type":"string",
            "example":"f"
        },
        "uePolicySetUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/ue-policy-set"
        },
        "usageMonUri":{
            "type":"string",
            "example":"/policy-data/ues/{ueId}/sm-data/{usageMonId}"
        }
    },
    "title":"UDRConfiguration"
}

Nested Schema : Indexing

Type: object

Title: Indexing

Show Source

• indexByExtid(optional): boolean
• indexByImsi(optional): boolean
• indexByMsisdn(optional): boolean
• indexByNai(optional): boolean

{
    "type":"object",
    "properties":{
        "indexByExtid":{
            "type":"boolean"
        },
        "indexByImsi":{
            "type":"boolean"
        },
        "indexByMsisdn":{
            "type":"boolean"
        },
        "indexByNai":{
            "type":"boolean"
        }
    },
    "title":"Indexing"
}

Nested Schema : keysPrecedence

Type: array

Show Source

• Array of: string
  Allowed Values: [ "EXTID", "IMSI", "MSISDN", "NAI" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "EXTID",
            "IMSI",
            "MSISDN",
            "NAI"
        ]
    }
}

Nested Schema : userIndexKeys

Type: array

Show Source

• Array of: string
  Allowed Values: [ "extid", "imsi", "msisdn", "nai" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "extid",
            "imsi",
            "msisdn",
            "nai"
        ]
    }
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

405 Response

Method Not Allowed

406 Response

Not Acceptable

408 Response

Request Timeout

409 Response

Conflict

412 Response

Precondition Failed

500 Response

Internal Server Error

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top