PATCH /serviceauthprofile/{uuid}

PATCH /serviceauthprofile/{uuid}

/serviceauthprofile/{uuid}

Request
URI
PATCH
https://{api_host}/api/serviceauthprofile/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

ServiceAuthProfile object creation

ServiceAuthProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "type": "string"
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "name": "string",
    "service_oauth_profile": {
        "authorization_endpoint": "string",
        "client_id": "string",
        "org_id": "string",
        "service_id": "string",
        "service_name": "string"
    },
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns ServiceAuthProfile of type(s) application/json 
"ServiceAuthProfile Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

Description for the service Auth Profile. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name of the service Auth Profile. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
service_oauth_profile
Optional

service_oauth_profile

string
tenant_ref
Optional

Tenant ref for the service auth profile. It is a reference to an object of type Tenant. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
type
Required

Type of the service Auth Profile. Enum options - SERVICE_AUTH_OAUTH. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the service Auth Profile. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}'
On This Page
Service Auth Profile Operations
GET
GET /serviceauthprofile
POST
POST /serviceauthprofile
GET
GET /serviceauthprofile/{uuid}
PUT
PUT /serviceauthprofile/{uuid}
PATCH
PATCH /serviceauthprofile/{uuid}
DELETE
DELETE /serviceauthprofile/{uuid}