IAM API (v2022-09-22)
Download OpenAPI specification:Download
Create a new access token
Create a new access token for a service
Authorizations:
Request Body schema: required
client_id required | string The client identifier to constrain the token to (In case of the |
client_secret required | string The secret associated with the client that authorizes the generation of token it's behalf (In case of the |
grant_type required | string (grant_type) Value: "client_credentials" A suggestion to the token generation which type of credentials are being provided |
Responses
Request samples
- Payload
{- "client_id": "427300db-db47-5080-a3c1-960ab1b2863e",
- "client_secret": "sLk2ICQRRO0wEoiTJ5D1XPEOIQIZ5tsU2WV0Bj9nylFP6",
- "grant_type": "client_credentials"
}
Response samples
- 200
- 400
- 401
- 500
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
Create a new role
Create a new role.
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Warrify-Idempotency-Token | string [ 10 .. 256 ] characters ^[a-zA-Z0-9_-]{10,256}$ A client generated id used to identify retried requests to ensure idempotency. |
Request Body schema: application/vnd.api+jsonrequired
type required | string Value: "roles" |
required | object |
Responses
Request samples
- Payload
{- "type": "roles",
- "attributes": {
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
], - "testing": false
}
}
Response samples
- 201
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "AdministratorAccess",
- "type": "roles",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
], - "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
List roles
List all roles
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": [
- {
- "id": "AdministratorAccess",
- "type": "roles",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
], - "testing": false
}
}
], - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Describe a role
Fetch details of a role
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
role_id required | string <= 64 characters The id of the role |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "AdministratorAccess",
- "type": "roles",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
], - "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Update a role
Update a role
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
role_id required | string <= 64 characters The id of the role |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Request Body schema: application/vnd.api+jsonrequired
id required | string [ 3 .. 64 ] characters ^[a-zA-Z][a-zA-Z0-9-._:@]+[a-zA-Z0-9]$ The id of the role |
type required | string Value: "roles" |
required | object non-empty |
Responses
Request samples
- Payload
{- "id": "AdministratorAccess",
- "type": "roles",
- "attributes": {
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
]
}
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "AdministratorAccess",
- "type": "roles",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "AdministratorAccess",
- "description": "string",
- "permissions": [
- {
- "action": "checkout:sales:create",
- "effect": [
- "allow"
]
}
], - "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Delete a role
Delete a role
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
role_id required | string <= 64 characters The id of the role |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Invite a new member to a tenant
Invite a new member to a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Warrify-Idempotency-Token | string [ 10 .. 256 ] characters ^[a-zA-Z0-9_-]{10,256}$ A client generated id used to identify retried requests to ensure idempotency. |
Request Body schema: application/vnd.api+jsonrequired
type required | string Value: "invitations" |
required | object |
Responses
Request samples
- Payload
{- "type": "invitations",
- "attributes": {
- "testing": false
}
}
Response samples
- 201
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "Vb4nCNvMcTyQX4hdmPuQZ",
- "type": "invitations",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
List invitations
List invitations.
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": [
- {
- "id": "Vb4nCNvMcTyQX4hdmPuQZ",
- "type": "invitations",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}
], - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Cancel an open invitation
Cancel an open invitation
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
invitation_id required | string <= 64 characters The id of an invitation |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
List members of a tenant
List all members of a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": [
- {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "members",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "email": "user@example.com",
- "testing": false
}
}
], - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Describe a member
Describe a member
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
user_id required | string <uuid> The id of the user |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "members",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "email": "user@example.com",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Remove a user from a tenant
Remove a user from a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
user_id required | string <uuid> The id of the user |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Create a new client
Create a new client. The calling principal will be granted admin permissions on the new client.
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Warrify-Idempotency-Token | string [ 10 .. 256 ] characters ^[a-zA-Z0-9_-]{10,256}$ A client generated id used to identify retried requests to ensure idempotency. |
Request Body schema: application/vnd.api+jsonrequired
type required | string Value: "clients" |
required | object |
Responses
Request samples
- Payload
{- "type": "clients",
- "attributes": {
- "name": "PoS",
- "testing": false
}
}
Response samples
- 201
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "sc_bcVb4nCNvMcTyQX4hdmPuQZ",
- "type": "clients",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "PoS",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
List clients
List all clients
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": [
- {
- "id": "sc_bcVb4nCNvMcTyQX4hdmPuQZ",
- "type": "clients",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "PoS",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}
], - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Describe a client
Fetch details of a client
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
client_id required | string <= 64 characters The id of the client |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "sc_bcVb4nCNvMcTyQX4hdmPuQZ",
- "type": "clients",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "PoS",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Update a client
Update a client
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
client_id required | string <= 64 characters The id of the client |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Request Body schema: application/vnd.api+jsonrequired
id required | string [ 3 .. 64 ] characters ^[a-zA-Z][\w-]+[a-zA-Z0-9]$ The id of the client |
type required | string Value: "clients" |
required | object non-empty |
Responses
Request samples
- Payload
{- "id": "sc_bcVb4nCNvMcTyQX4hdmPuQZ",
- "type": "clients",
- "attributes": {
- "name": "PoS",
- "testing": false
}
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "sc_bcVb4nCNvMcTyQX4hdmPuQZ",
- "type": "clients",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "name": "PoS",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Delete a client
Delete a client
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
client_id required | string <= 64 characters The id of the client |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Generate new client credentials
Generate new client credentials
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
client_id required | string <= 64 characters The id of the client |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 201
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "client-credentials",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "clientId": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "clientSecret": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "createdAt": "2019-08-24T14:15:22Z"
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Revoke client credentials
Revoke client credentials
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
client_id required | string <= 64 characters The id of the client |
key_id required | string <= 64 characters The id of access key |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Create a new tenant
Create a new tenant. The calling principal will be granted admin permissions on the new tenant.
Authorizations:
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Warrify-Idempotency-Token | string [ 10 .. 256 ] characters ^[a-zA-Z0-9_-]{10,256}$ A client generated id used to identify retried requests to ensure idempotency. |
Request Body schema: application/vnd.api+jsonrequired
type required | string Value: "tenants" |
required | object |
Responses
Request samples
- Payload
{- "type": "tenants",
- "attributes": {
- "name": "string",
- "lookupId": "warrify.com",
- "testing": false
}
}
Response samples
- 201
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "tenants",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "name": "string",
- "lookupId": "warrify.com",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Describe a tenant
Fetch details of a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "tenants",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "name": "string",
- "lookupId": "warrify.com",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Update a tenant
Update a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Request Body schema: application/vnd.api+jsonrequired
id required | string <uuid> The id of the tenant |
type required | string Value: "tenants" |
required | object non-empty |
Responses
Request samples
- Payload
{- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "tenants",
- "attributes": {
- "name": "string",
- "lookupId": "warrify.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "data": {
- "id": "aa3c0b5a-fd0b-4f33-9ab2-38411ac119e3",
- "type": "tenants",
- "attributes": {
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:global:iam:roles:NrcJUTXnPi",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "name": "string",
- "lookupId": "warrify.com",
- "testing": false
}
}, - "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}
}
Delete a tenant
Delete a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-09-22" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}