Amazon DataZone Datazone User Profiles API
The Datazone User Profiles API from Amazon DataZone — 2 operation(s) for datazone user profiles.
The Datazone User Profiles API from Amazon DataZone — 2 operation(s) for datazone user profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-user-profiles-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon DataZone User Profiles API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datazone.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: User Profiles
paths:
/v2/domains/{domainIdentifier}/user-profiles:
post:
operationId: CreateUserProfile
summary: Create User Profile
description: Creates a user profile in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserProfileOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserProfileInput'
tags:
- User Profiles
/v2/domains/{domainIdentifier}/user-profiles/{userIdentifier}:
get:
operationId: GetUserProfile
summary: Get User Profile
description: Gets a user profile in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserProfileOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserProfileInput'
tags:
- User Profiles
put:
operationId: UpdateUserProfile
summary: Update User Profile
description: Updates the specified user profile in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserProfileOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserProfileInput'
tags:
- User Profiles
components:
schemas:
IamUserProfileDetails:
type: object
properties:
arn:
type: string
description: The ARN of the IAM user.
principalId:
type: string
description: The principal ID as part of the IAM user profile details.
sessionName:
type: string
description: The session name for IAM role sessions.
groupProfileId:
type: string
description: The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
GetUserProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: the ID of the Amazon DataZone domain the data portal of which you want to get.
userIdentifier:
type: string
description: The identifier of the user for which you want to get the user profile.
type:
type: string
enum:
- IAM
- SSO
description: The type of the user profile.
sessionName:
type: string
description: The session name for IAM role sessions.
required:
- domainIdentifier
- userIdentifier
CreateUserProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which a user profile is created.
userIdentifier:
type: string
description: The identifier of the user for which the user profile is created.
userType:
type: string
enum:
- IAM_USER
- IAM_ROLE
- SSO_USER
- IAM_ROLE_SESSION
description: The user type of the user for which the user profile is created.
sessionName:
type: string
description: The session name for IAM role sessions.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- userIdentifier
UpdateUserProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which a user profile is updated.
userIdentifier:
type: string
description: The identifier of the user whose user profile is to be updated.
type:
type: string
enum:
- IAM
- SSO
description: The type of the user profile that are to be updated.
status:
type: string
enum:
- ASSIGNED
- NOT_ASSIGNED
- ACTIVATED
- DEACTIVATED
description: The status of the user profile that are to be updated.
sessionName:
type: string
description: The session name for IAM role sessions.
required:
- domainIdentifier
- userIdentifier
- status
ValidationException:
type: object
properties:
message:
type: string
required:
- message
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
SsoUserProfileDetails:
type: object
properties:
username:
type: string
description: The username as part of the SSO user profile detail.
firstName:
type: string
description: The first name as part of the SSO user profile detail.
lastName:
type: string
description: The last name as part of the SSO user profile detail.
CreateUserProfileOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a user profile is created.
id:
type: string
description: The identifier of the user profile.
type:
type: string
enum:
- IAM
- SSO
description: The type of the user profile.
status:
type: string
enum:
- ASSIGNED
- NOT_ASSIGNED
- ACTIVATED
- DEACTIVATED
description: The status of the user profile.
details:
$ref: '#/components/schemas/UserProfileDetails'
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
UpdateUserProfileOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a user profile is updated.
id:
type: string
description: The identifier of the user profile.
type:
type: string
enum:
- IAM
- SSO
description: The type of the user profile.
status:
type: string
enum:
- ASSIGNED
- NOT_ASSIGNED
- ACTIVATED
- DEACTIVATED
description: The status of the user profile.
details:
$ref: '#/components/schemas/UserProfileDetails'
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
GetUserProfileOutput:
type: object
properties:
domainId:
type: string
description: the identifier of the Amazon DataZone domain of which you want to get the user profile.
id:
type: string
description: The identifier of the user profile.
type:
type: string
enum:
- IAM
- SSO
description: The type of the user profile.
status:
type: string
enum:
- ASSIGNED
- NOT_ASSIGNED
- ACTIVATED
- DEACTIVATED
description: The status of the user profile.
details:
$ref: '#/components/schemas/UserProfileDetails'
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
UserProfileDetails:
type: object
properties:
iam:
$ref: '#/components/schemas/IamUserProfileDetails'
sso:
$ref: '#/components/schemas/SsoUserProfileDetails'
description: Exactly one member is set.
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: datazone
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)