Method: mobileProfiles.assign

  • The mobileProfiles:assign method assigns an active mobile profile to a device based on an offerType and optionally an EID or IMEI.

  • The request body includes the required offerType and optional eid and imei fields.

  • The response body returns the iccId and activationCode of the assigned mobile profile.

  • The method requires specific OAuth scopes for authorization.

Assigns an active mobile profile to a device if eligible for the offerType.

HTTP request

POST https://fiwholesaleadaptor.googleapis.com/v1/mobileProfiles:assign

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "offerType": enum (OfferType),
  "eid": string,
  "imei": string
}
Fields
offerType

enum (OfferType)

Required. The type of offer to assign a profile for.
eid

string

Optional. The EID of the eSIM to assign the profile to.
imei

string

Optional. The IMEI of the device to assign the profile to.

Response body

Returns an active mobile profile. If there is no available active profile, return an error so the client will retry later on when more profiles are available.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "iccId": string,
  "activationCode": string
}
Fields
iccId

string

Integrated Circuit Card Identification Number, a unique id for a carrier profile.
activationCode

string

Profile activation code used to reference the profile in SM-DP+ server for profile downloading.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/nova
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.