API docs by Redocly

NRF OAuth2 (1.3.1)

Download OpenAPI specification:

NRF OAuth2 Authorization.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.510 V18.8.0; 5G System; Network Function Repository Services; Stage 3

Access Token Request

Access Token Request

header Parameters
Content-Encoding
string

Content-Encoding, described in IETF RFC 9110

Accept-Encoding
string

Accept-Encoding, described in IETF RFC 9110

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "client_credentials"
nfInstanceId
required
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

string or string (NFType)

NF types known to NRF

string or string (NFType)

NF types known to NRF

scope
required
string^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
targetNfInstanceId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

Array of objects (PlmnId) >= 2 items
Array of objects (Snssai) non-empty
requesterFqdn
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

Array of objects (PlmnIdNid) non-empty
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

Array of objects (Snssai) non-empty
targetNsiList
Array of strings non-empty
targetNfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

targetNfServiceSetId
string (NfServiceSetId)

NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or "set.sn.nfi.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition) encoded as defined in clause 5.3.2 encoded as defined in 3GPP TS 29.510 encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

hnrfAccessTokenUri
string (Uri)

String providing an URI formatted according to RFC 3986.

sourceNfInstanceId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

vendorId
string (VendorId) ^[0-9]{6}$

Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA)

Array of strings or strings (NwdafEvent) non-empty
Array of objects (MlModelInterInd) non-empty
sourceVendorId
string (VendorId) ^[0-9]{6}$

Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string"
}