github.com/twilio/twilio-go@v1.20.1/rest/supersim/v1/docs/NetworkAccessProfilesApi.md (about)

     1  # NetworkAccessProfilesApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateNetworkAccessProfile**](NetworkAccessProfilesApi.md#CreateNetworkAccessProfile) | **Post** /v1/NetworkAccessProfiles | 
     8  [**FetchNetworkAccessProfile**](NetworkAccessProfilesApi.md#FetchNetworkAccessProfile) | **Get** /v1/NetworkAccessProfiles/{Sid} | 
     9  [**ListNetworkAccessProfile**](NetworkAccessProfilesApi.md#ListNetworkAccessProfile) | **Get** /v1/NetworkAccessProfiles | 
    10  [**UpdateNetworkAccessProfile**](NetworkAccessProfilesApi.md#UpdateNetworkAccessProfile) | **Post** /v1/NetworkAccessProfiles/{Sid} | 
    11  
    12  
    13  
    14  ## CreateNetworkAccessProfile
    15  
    16  > SupersimV1NetworkAccessProfile CreateNetworkAccessProfile(ctx, optional)
    17  
    18  
    19  
    20  Create a new Network Access Profile
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreateNetworkAccessProfileParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
    34  **Networks** | **[]string** | List of Network SIDs that this Network Access Profile will allow connections to.
    35  
    36  ### Return type
    37  
    38  [**SupersimV1NetworkAccessProfile**](SupersimV1NetworkAccessProfile.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: application/x-www-form-urlencoded
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## FetchNetworkAccessProfile
    55  
    56  > SupersimV1NetworkAccessProfile FetchNetworkAccessProfile(ctx, Sid)
    57  
    58  
    59  
    60  Fetch a Network Access Profile instance from your account.
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **Sid** | **string** | The SID of the Network Access Profile resource to fetch.
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a FetchNetworkAccessProfileParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  
    78  ### Return type
    79  
    80  [**SupersimV1NetworkAccessProfile**](SupersimV1NetworkAccessProfile.md)
    81  
    82  ### Authorization
    83  
    84  [accountSid_authToken](../README.md#accountSid_authToken)
    85  
    86  ### HTTP request headers
    87  
    88  - **Content-Type**: Not defined
    89  - **Accept**: application/json
    90  
    91  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    92  [[Back to Model list]](../README.md#documentation-for-models)
    93  [[Back to README]](../README.md)
    94  
    95  
    96  ## ListNetworkAccessProfile
    97  
    98  > []SupersimV1NetworkAccessProfile ListNetworkAccessProfile(ctx, optional)
    99  
   100  
   101  
   102  Retrieve a list of Network Access Profiles from your account.
   103  
   104  ### Path Parameters
   105  
   106  This endpoint does not need any path parameter.
   107  
   108  ### Other Parameters
   109  
   110  Other parameters are passed through a pointer to a ListNetworkAccessProfileParams struct
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   116  **Limit** | **int** | Max number of records to return.
   117  
   118  ### Return type
   119  
   120  [**[]SupersimV1NetworkAccessProfile**](SupersimV1NetworkAccessProfile.md)
   121  
   122  ### Authorization
   123  
   124  [accountSid_authToken](../README.md#accountSid_authToken)
   125  
   126  ### HTTP request headers
   127  
   128  - **Content-Type**: Not defined
   129  - **Accept**: application/json
   130  
   131  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   132  [[Back to Model list]](../README.md#documentation-for-models)
   133  [[Back to README]](../README.md)
   134  
   135  
   136  ## UpdateNetworkAccessProfile
   137  
   138  > SupersimV1NetworkAccessProfile UpdateNetworkAccessProfile(ctx, Sidoptional)
   139  
   140  
   141  
   142  Updates the given properties of a Network Access Profile in your account.
   143  
   144  ### Path Parameters
   145  
   146  
   147  Name | Type | Description
   148  ------------- | ------------- | -------------
   149  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   150  **Sid** | **string** | The SID of the Network Access Profile to update.
   151  
   152  ### Other Parameters
   153  
   154  Other parameters are passed through a pointer to a UpdateNetworkAccessProfileParams struct
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **UniqueName** | **string** | The new unique name of the Network Access Profile.
   160  
   161  ### Return type
   162  
   163  [**SupersimV1NetworkAccessProfile**](SupersimV1NetworkAccessProfile.md)
   164  
   165  ### Authorization
   166  
   167  [accountSid_authToken](../README.md#accountSid_authToken)
   168  
   169  ### HTTP request headers
   170  
   171  - **Content-Type**: application/x-www-form-urlencoded
   172  - **Accept**: application/json
   173  
   174  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   175  [[Back to Model list]](../README.md#documentation-for-models)
   176  [[Back to README]](../README.md)
   177