Jump to

• Request
• Response
• Examples

Create a Service Account

post

/apiplatform/management/v1/serviceaccounts

Creates a Service Account.

Users requesting this resource must be assigned the Service Manager role.

Request

Supported Media Types

• application/json

Body ()

Root Schema : CreateServiceAccountRequest

Match All

Show Source

• object ServiceAccountIdentity
• object ServiceAccountDef

{
    "allOf":[
        {
            "$ref":"#/definitions/ServiceAccountIdentity"
        },
        {
            "$ref":"#/definitions/ServiceAccountDef"
        }
    ]
}

Nested Schema : ServiceAccountIdentity

Type: object

Show Source

• name: string
  The service account's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The service account's name."
        }
    }
}

Nested Schema : ServiceAccountDef

Type: object

Show Source

• configuration(optional): object configuration
  The service account's configuration.
• description(optional): string
  The service account's description.
• type(optional): string
  The type of service account, either Basic or OAuth or WSSUsername.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The service account's description."
        },
        "type":{
            "type":"string",
            "description":"The type of service account, either <code>Basic</code> or <code>OAuth</code> or <code>WSSUsername</code>."
        },
        "configuration":{
            "type":"object",
            "description":"The service account's configuration.",
            "properties":{
                "password":{
                    "type":"string",
                    "description":"The password. On read, the password is replaced by the password key."
                },
                "tokenTransferOption":{
                    "type":"string",
                    "description":"The service account's description."
                },
                "clientId":{
                    "type":"string",
                    "description":"The client ID."
                },
                "tokenEndpointUrl":{
                    "type":"string",
                    "description":"The token endpoint URL."
                },
                "clientSecret":{
                    "type":"string",
                    "description":"The client secret. On read, the client secret is replaced by the client secret key."
                },
                "scopes":{
                    "type":"string",
                    "description":"Optional scopes."
                },
                "grant":{
                    "type":"object",
                    "description":"The OAuth grant",
                    "properties":{
                        "password":{
                            "type":"string",
                            "description":"The password. On read, the password is replaced by the password key."
                        },
                        "type":{
                            "type":"string",
                            "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
                        },
                        "username":{
                            "type":"string",
                            "description":"The username."
                        }
                    }
                },
                "username":{
                    "type":"string",
                    "description":"The username."
                }
            }
        }
    }
}

Nested Schema : configuration

Type: object

The service account's configuration.

Show Source

• clientId(optional): string
  The client ID.
• clientSecret(optional): string
  The client secret. On read, the client secret is replaced by the client secret key.
• grant(optional): object grant
  The OAuth grant
• password(optional): string
  The password. On read, the password is replaced by the password key.
• scopes(optional): string
  Optional scopes.
• tokenEndpointUrl(optional): string
  The token endpoint URL.
• tokenTransferOption(optional): string
  The service account's description.
• username(optional): string
  The username.

{
    "type":"object",
    "description":"The service account's configuration.",
    "properties":{
        "password":{
            "type":"string",
            "description":"The password. On read, the password is replaced by the password key."
        },
        "tokenTransferOption":{
            "type":"string",
            "description":"The service account's description."
        },
        "clientId":{
            "type":"string",
            "description":"The client ID."
        },
        "tokenEndpointUrl":{
            "type":"string",
            "description":"The token endpoint URL."
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret. On read, the client secret is replaced by the client secret key."
        },
        "scopes":{
            "type":"string",
            "description":"Optional scopes."
        },
        "grant":{
            "type":"object",
            "description":"The OAuth grant",
            "properties":{
                "password":{
                    "type":"string",
                    "description":"The password. On read, the password is replaced by the password key."
                },
                "type":{
                    "type":"string",
                    "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
                },
                "username":{
                    "type":"string",
                    "description":"The username."
                }
            }
        },
        "username":{
            "type":"string",
            "description":"The username."
        }
    }
}

Nested Schema : grant

Type: object

The OAuth grant

Show Source

• password(optional): string
  The password. On read, the password is replaced by the password key.
• type(optional): string
  The grant type, either ClientCredentials or ResourceOwnerCredentials.
• username(optional): string
  The username.

{
    "type":"object",
    "description":"The OAuth grant",
    "properties":{
        "password":{
            "type":"string",
            "description":"The password. On read, the password is replaced by the password key."
        },
        "type":{
            "type":"string",
            "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
        },
        "username":{
            "type":"string",
            "description":"The username."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The service account was created.

Body ()

Root Schema : ServiceAccountId

Type: object

Show Source

• id: string
  The service account's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service account's ID."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to create a service account by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @servicesacc-post.json
https://example.com/apiplatform/management/v1/serviceaccounts

Example of Request Body

The following shows an example of the request body, included with the request above in a file named servicesacc-post.json.

{
    "name": "basic",
    "description": "canned service account",
    "type": "Basic",
    "configuration": {
        "username": "foo",
        "password": "bar"
    }
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 201 Created
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Wed, 26 Jul 2017 17:10:11 GMT
Content-Length:  12
Content-type: application/json
X-oracle-dms-ecid: kKFfG1P0000000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc-config
Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including the ID of the created service account.

{
    "id": "100"
}

Back to Top