Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Setting

Description

Grant Type

Select the grant type:

  • Client Credentials
    The agent fetches the access token from the Access Token URI during initialization, using client id and client secret for basic authentication. The credentials are base64 encoded and sent in the header of the request.
    The response contains an access token, which is then used in subsequent requests.

  • Resource Owner Password Credentials

    The agent fetches the access token from the Access Token URI during initialization, using the following credentials for authentication:

    • Client ID

    • Client Secret

    • Username

    • Password

    The credentials are sent in the body of the request. The response contains an access token, which is then used in subsequent requests. 

Client ID

Enter the unique client identifier issued by the authorization server.

Client Secret

Enter the client secret issued by the authorization server.

Username

Enter the resource owner username, this can be the end-user granting access to a protected resource. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Password

Enter the password associated with the username. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Access Token URI

Enter the URI where the access token can be obtained.

Token expiration override (sec)

Enter a time in seconds when you would like to refresh the access token prior to the expiration. This allows the application to obtain a new access token without the user's interaction. 

Additional Parameters

Some authentication servers may require additional parameters in the body of the token requests. To add a parameter, click the Add button and then enter the name of the parameter in the Key field and the value of the parameter in the Value field.

Do not use escape characters in the value field, these will be added automatically by the HTTP2 Client agent. For instance, "https://example.com/" will be sent as "https%3A%2F%2example.com%2F".

Note

Note!

If an agent is configured on the Authentication Tab to use OAuth 2.0, an additional step may be required if the token needs to be obtained via HTTPS protocol.

The HTTP/2 Client internally uses the Java built-in HTTP Client to obtain a token. If a certificate is required to contact the authorization server, the proper certificate has to be imported into the pod.

For more information on steps to import the necessary certificate, refer to Importing Certificate to JDK/JRE Security Cacert in Kubernetes Pods (4.3).

...

Setting

Description

Authorization Server (NRF)

Enter the full URL path for the authorization server. If you enter an https URL, you must select the checkbox Use SSL.

Use SSL

If you want to use encryption, select this checkbox.

Security Profile

If you prefer to use a secure connection, click Browse to select a security profile with certificate and configuration. Refer to Security (4.3) for more information.

NF Instance ID

Enter the NF instance ID of the server that you want to send requests from.

Scope

Enter a string for the service(s) that you want to use, separated by whitespaces.

Optional Parameters

NF Type

The NF type available for selection is CHF (charging function). If you select this setting, you must also select the Target NF Type.

This is included in an access token request for an NF Type but not for a specific NF/NF service instance.

Target NF Instance ID

Enter the NF instance ID of the server for which the access token is requested.

This is included in an access token request for a specific NF service provider and shall contain NF Instance ID of the specific NF service provider. 

Target NF Type

The NF type available for selection is CHF (charging function). If you select this setting, you must also select NF Type.

This is included in an access token request for an NF Type but not for a specific NF/NF service instance.

Requester FQDN

Enter the Requester FQDN (Fully Qualified Domain Name). This is used by the NRF (Network Repository Function) to validate that the requester NF service consumer is allowed to access the target NF service provider.

Target NF Set ID

Enter the Target NF Set ID of the consumer profile. This is included in the access token request of the NF type.

Target NF Service Set ID

Enter the Target NF Service Set ID of the consumer profile. This is used by the NRF (Network Repository Function) to validate that the requester NF service consumer is allowed to access the target NF service instance.

Hnrf Access Token URI

Enter the Hnrf URI where the access token can be obtained.

Source NF Instance ID

Enter the Source NF Instance ID of the service provider. This contains the NF Instance ID of the source NF to collect data from the NF service provider. 

Requester PLMN 

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester PLMN)

PLMN ID

MCC

Enter the mobile country code (MCC) for the Requester PLMN (Public Land Mobile Network) ID If you enter values for the PLMN ID, you must enter values for the Target PLMN ID - MCC.

MNC

Enter the mobile network code (MNC) for the Requester PLMN (Public Land Mobile Network) ID. If you enter values for the PLMN ID, you must enter values for the Target PLMN ID - MNC.

Customize Format

Select this option to enter customized formats for the Requester PLMN ID. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above MCC and MNC fields will be disabled.

Target PLMN

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target PLMN)

Target PLMN ID

MCC

Enter the mobile country code (MCC) for the Target PLMN (Public Land Mobile Network) ID. This value is required if you have opted to enter the value for Requester PLMN ID - MCC.

MNC

Enter the mobile network code (MNC) for the Target PLMN (Public Land Mobile Network) ID. This value is required if you have opted to enter the value for Requester PLMN ID - MNC.

Customize Format

Select this option to enter customized formats for the Target PLMN ID. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above MCC and MNC fields will be disabled.

Target SNPN

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target SNPN)

MCC

Enter the mobile country code (MCC) for the Target SNPN (Standalone Non-Public Network).

MNC

Enter the mobile network code (MNC) for the Target SNPN (Standalone Non-Public Network).

NID

Enter the network identifier (NID) for the Target SNPN (Standalone Non-Public Network).

Customize Format

Select this option to enter customized formats for the Target SNPN. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above MCCMNC and NID fields will be disabled.

Requester S-NSSAI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester S-NSSAI List)

S-NSSAI List

Enter the Requester S-NSSAI(s) (Single Network Slice Selection Assistance Information) of the service provider. 

This is included during an access token request for an NF type and not for a specific NF / NF service instance.

Customize Format

Select this option to enter customized formats for the Requester S-NSSAI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above S-NSSAI List field will be disabled.

Target S-NSSAI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target S-NSSAI List)

Target S-NSSAI list

Enter the Target S-NSSAI(s) (Single Network Slice Selection Assistance Information) of the service provider. This list may be included for NF type access token request but not for a specific NF/NF service instance. 

Customize Format

Select this option to enter customized formats for the Target S-NSSAI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above Target S-NSSAI List field will be disabled.

Requester PLMN List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester PLMN List)

PLMN List

Enter the Requester PLMN (Public Land Mobile Network) of the service producer. 

Customize Format

Select this option to enter customized formats for the Requester PLMN list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above Requester PLMN List field will be disabled.

Requester SNPN List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester SNPN List)

SNPN List

Enter the Requester SNPN (Standalone Non-Public Network) of the service producer. 

Customize Format 

Select this option to enter customized formats for the Requester SNPN list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above Requester PLMN List field will be disabled.

Target NSI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target NSI List)

Target NSI list

Enter the target NSI(s) (Network Slice Instances). This list may be included for NF type access token request but not for a specific NF/NF service instance. 

Customize Format

Select this option to enter customized formats for the Target NSI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Note

Note!

By selecting this option, the above Target NSI field will be disabled.

...