Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.
openapi: 3.2.0
info:
title: Stackit Users API
version: '2.0'
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged Users across 2 of this provider''s published API definitions: stackit-authorization-v2.json, stackit-authorization-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://authorization.api.stackit.cloud
variables:
region:
default: global
tags:
- name: Users
paths:
/v2/users/{email}/memberships:
get:
description: List memberships of a user. An administrative access is needed to list any user's memberships, while the user can do it on his/her own email. You can use filters to scope the request to a project/folder/organization. In this case -if caller is not the subject-, owner permissions are required. Because of hierarchical role bindings, the user might have permissions on more resources.
operationId: ListUserMemberships
parameters:
- in: path
name: email
required: true
schema:
type: string
- in: query
name: resourceType
schema:
type: string
- in: query
name: resourceId
schema:
type: string
- in: query
name: parentResourceId
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserMembershipsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Malformed input
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Forbidden
summary: List memberships of a user
x-stackit-authorization:
disabled: true
implicit-actions:
- iam.member.get
tags:
- Users
servers:
- url: https://authorization.api.stackit.cloud
variables:
region:
default: global
/v2/users/{email}/permissions:
get:
description: List permissions of a user. An administrative access is needed to list any user's permissions, while the user can do it on his/her own email. Lists every resource of the given type where the user has any effective permissions. When requested, also lists why the permission is present.
operationId: ListUserPermissions
parameters:
- in: path
name: email
required: true
schema:
type: string
- in: query
name: resource
schema:
type: string
- in: query
name: resourceType
schema:
type: string
- in: query
name: permissions
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserPermissionsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Malformed input
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Forbidden
summary: List permissions of a user
x-stackit-authorization:
disabled: true
implicit-actions:
- iam.member.get
tags:
- Users
servers:
- url: https://authorization.api.stackit.cloud
variables:
region:
default: global
components:
schemas:
ListUserMembershipsResponse:
properties:
items:
items:
$ref: '#/components/schemas/UserMembership'
type: array
required:
- items
type: object
ErrorResponse:
example:
error: Bad Request
message: Some information about what caused the Error
path: /v1/path/which/returned/error
status: 400
timeStamp: '2019-08-24T14:15:22Z'
properties:
error:
type: string
message:
type: string
path:
type: string
status:
type: integer
timeStamp:
format: date-time
type: string
required:
- timeStamp
- path
- status
- error
- message
type: object
ListUserPermissionsResponse:
properties:
items:
items:
$ref: '#/components/schemas/UserPermission'
type: array
required:
- items
type: object
UserMembership:
properties:
resourceId:
example: schwarz-it-kg-WJACUK1
pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
title: The ID of the resource
type: string
resourceType:
example: organization
pattern: ^[a-z](?:-?[a-z]){1,63}$
title: Resource type
type: string
role:
example: my-owner
pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
title: A valid role defined for the resource.
type: string
subject:
maxLength: 255
title: Identifier of user, service account or client. Usually email address or name in case of clients.
type: string
required:
- resourceId
- resourceType
- subject
- role
type: object
UserPermission:
properties:
permissions:
items:
$ref: '#/components/schemas/ExistingPermission'
type: array
resourceId:
example: schwarz-it-kg-WJACUK1
pattern: ^([a-zA-Z0-9/_|\-=+@.]{1,})$
title: The ID of the resource
type: string
resourceType:
example: organization
pattern: ^[a-z](?:-?[a-z]){1,63}$
title: Resource type
type: string
required:
- resourceId
- resourceType
- permissions
type: object
ExistingPermission:
properties:
description:
example: Can create projects in an organization
maxLength: 255
title: A human readable description of the permission
type: string
name:
example: iam.member.read
maxLength: 255
pattern: ^[a-z](?:[-.]?[a-z]){1,63}$
title: Permission of the subject
type: string
required:
- name
- description
type: object
x-refined-from:
- stackit-authorization-v2.json
- stackit-authorization-openapi.yml